diff --git a/src/pages/docs/runbooks/index.mdx b/src/pages/docs/runbooks/index.mdx index 33c01ec8bc..9516ca14d6 100644 --- a/src/pages/docs/runbooks/index.mdx +++ b/src/pages/docs/runbooks/index.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-05-24 +modDate: 2026-01-28 title: Runbooks subtitle: Automate routine maintenance and emergency operations tasks icon: fa-solid fa-repeat @@ -12,7 +12,7 @@ navOrder: 90 --- Deployments are just one piece of the deployment puzzle. You also have to manage day-1 and day-2 operations. Octopus Runbooks lets you automate these routine and emergency operations tasks, giving you one platform for DevOps automation. -A runbook is a set of instructions that help you consistently carry out a task, whether it's routine maintenance or responding to an incident. Octopus provides the platform for your runbooks just as it does for your deployments. +A runbook is a set of instructions that help you consistently carry out a task, whether it's routine maintenance or responding to an incident. Octopus provides the platform for your runbooks just as it does for your deployments. Runbooks automate routine maintenance and emergency operations tasks, like: @@ -32,11 +32,13 @@ Runbooks help you: - Free your teams for more crucial work ## How runbooks work + You can set permissions so anyone on a team can start a runbook, or you can limit access to specific environments. Octopus handles access control and provides a complete audit trail. This makes runbooks ideal for creating safe and secure, self-service, push-button operations. This also frees up your Ops team from time-consuming, repetitive tasks. You can also use prompted variables with runbooks if you need human interaction, like a review. Because you don't need to grant access to the underlying infrastructure, reviews and approvals can happen in Octopus, too. This keeps the whole process in one place. The audit log stores changes to runbooks, requests to run them, and approvals, for complete transparency. ## Types of runbooks + There are 3 common types of runbooks: - **Routine operations** - where you replace manual operations and ClickOps with runbooks. The goal is to move all toil into runbooks so you don’t need to remote into servers or click through cloud management portals. You can use Octopus to bring these tasks into one place and make them self-service or automatic. @@ -46,16 +48,36 @@ There are 3 common types of runbooks: Learn more about the ways you can use runbooks in our [runbooks examples](/docs/runbooks/runbook-examples). ## Getting started + Runbooks belong to projects. To create or manage your runbooks, navigate to **Deploy ➜ Runbooks ➜ Add Runbook**. :::figure ![Add Runbook](/docs/img/runbooks/create-a-runbook.png) ::: +## Runbook tags \{#runbook-tags} + +:::div{.warning} +Tagging runbooks is supported from Octopus version **2026.1.xxxx**. +::: + +You can apply tags to runbooks with custom metadata. This allows you to: + +- Organize runbooks by custom attributes to suit your team's needs. +- Filter runbooks by tags to quickly find relevant automation tasks. +- Group related runbooks together for easier management. + +:::div{.hint} +Only tags from tag sets that have been configured with the **Runbook** scope can be used to tag runbooks. +::: + +Learn more about [tag sets](/docs/tenants/tag-sets), including tag set types, scopes, and how to create and manage them. + ## Learn more + - [Runbooks versus deployments](/docs/runbooks/runbooks-vs-deployments) - Learn how runbooks differ from deployments - [Runbooks permissions](/docs/runbooks/runbook-permissions) - Understand how to manage permissions - [Runbooks variables](/docs/runbooks/runbook-variables) - Learn how to manage variables -- [Runbooks publishing](https://octopus.com/docs/runbooks/runbook-publishing) - Learn about snapshots for runbooks +- [Runbooks publishing](https://octopus.com/docs/runbooks/runbook-publishing) - Learn about snapshots for runbooks - [Scheduled runbook triggers](https://octopus.com/docs/runbooks/scheduled-runbook-trigger) - Define an unattended behavior for your runbook -- [Runbook examples](https://octopus.com/docs/runbooks/runbook-examples) - Learn about the ways you can use runbooks \ No newline at end of file +- [Runbook examples](https://octopus.com/docs/runbooks/runbook-examples) - Learn about the ways you can use runbooks diff --git a/src/pages/docs/tenants/tag-sets.md b/src/pages/docs/tenants/tag-sets.md index 747f2b1662..4a6a698895 100644 --- a/src/pages/docs/tenants/tag-sets.md +++ b/src/pages/docs/tenants/tag-sets.md @@ -7,7 +7,7 @@ description: Tag sets are a categorizing system that let you add custom metadata navOrder: 35 --- -Tag sets provide the structure for grouping similar tags together, resulting in more orderly metadata. Currently, tags can be applied to tenants and environments, with support for additional resource types planned for the future. +Tag sets provide the structure for grouping similar tags together, resulting in more orderly metadata. Currently, tags can be applied to tenants, environments, projects, and runbooks, with support for additional resource types planned for the future. :::figure ![An example set of tenant tags](/docs/img/tenants/images/tag-sets.png) @@ -32,8 +32,9 @@ Tag sets can be scoped to specific resource types: - **Tenant** - **Environment** - **Project** +- **Runbook** -A tag set can be scoped to multiple resource types (Tenant, Environment, and/or Project), allowing you to use the same tag set across different resources. +A tag set can be scoped to multiple resource types (Tenant, Environment, Project, and/or Runbook), allowing you to use the same tag set across different resources. ## Managing tag sets {#managing-tag-sets} @@ -67,7 +68,7 @@ Order is important for tag sets, and tags within those tag sets. Octopus will so If tags are in use by resources, included in project/runbook release [variable snapshots](/docs/releases#variable-snapshot) (via project/variable sets), or captured in published runbooks, you will not be able to delete the relevant tag(s) until these associations are removed. -For projects using Config as Code, there are fewer guardrails in place. It's up to you to take care to avoid deleting any tags required by your deployments. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information. +For projects using Config as Code, there are fewer guardrails in place. It's up to you to take care to avoid deleting any tags required by your deployments. Similarly, for runbooks stored in version control, tag usage tracking is not supported, so you must manually ensure tags used by your Config as Code runbooks are not deleted. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information. ## Referencing tags {#referencing-tags} @@ -90,6 +91,7 @@ You can use canonical names when: - **[Tenant tags](/docs/tenants/tenant-tags):** Learn how to use tags to classify tenants, deploy to multiple tenants, and design multi-tenant deployment processes. - **[Environment tags](/docs/infrastructure/environments#environment-tags):** Learn how to use tags to classify environments by attributes like cloud provider, region, or tier. - **[Project tags](/docs/projects/setting-up-projects#project-tags):** Learn how to use tags to classify and organize projects. +- **[Runbook tags](/docs/runbooks#runbook-tags):** Learn how to use tags to organize and filter runbooks with custom metadata. ## Learn more