Rule Books

Rule Books are how you teach Stakpak agents to follow your way of doing things. Think of them as smart, markdown based SOPs (standard operating procedures), whether it’s how to deploy to production, upgrade infrastructure, or tag resources correctly. Stakpak uses Rule Books to make decisions that align with your team’s standards, not just generic best practices.

There are two types of rule books:

• Official Rule Books They are created by the Stakpak team, and they cover common workflows like Dockerization, infrastructure software upgrades, and cloud deployments. They follow industry best practices and are ready to use out of the box.

  • Dockerization

  • Infrastructure Cost Estimation

  • Infrastructure Software Upgrades

  • Simple Deployment On VM

  • Migrating Bitnami to Bitnami Legacy

• Your Rule Books Your custom Rule Books define how your team works. From deployment procedures to incident response, Stakpak will follow them step-by-step, just like a teammate would

Note:

• You can view and create your rule books at stakpak.dev

• You can disable the official rule books by opening your terminal and writing stakpak --disable-official-rulebooks

How to Enable/Disable Rule Books?

That depends on whether you want to enable/disable them just for a single session or across your entire account.

• Enabling/Disabling Rule Books for a Single Session

  • Open Stakpak, then prompt it to disable the rule books that you want to disable

• Enabling/Disabling Rule Books across your entire account

  • Open your terminal and type stakpak config sample

  • Here you can view everything you can edit

  

  • Then use your favorite editor to edit ~/.stakpak/config.toml

  • Then include/exclude the rule books you want

Now, let's take a look at the Official Rule Books in more detail