Add v1 Deployment & Ops Skills Taxonomy

src/current/_includes/v23.1/sidebar-data/self-hosted-deployments.json

@@ -8,6 +8,12 @@
               "/${VERSION}/recommended-production-settings.html"
             ]
         },
+        {
+            "title": "Deployment and Operations Skills Taxonomy",
+            "urls": [
+              "/${VERSION}/deployment-operations-skills-taxonomy.html"
+            ]
+        },
         {
             "title": "Deploy Locally",
             "items": [

src/current/_includes/v23.2/sidebar-data/self-hosted-deployments.json

@@ -8,6 +8,12 @@
               "/${VERSION}/recommended-production-settings.html"
             ]
         },
+        {
+            "title": "Deployment and Operations Skills Taxonomy",
+            "urls": [
+              "/${VERSION}/deployment-operations-skills-taxonomy.html"
+            ]
+        },
         {
             "title": "Deploy Locally",
             "items": [

src/current/_includes/v24.1/sidebar-data/self-hosted-deployments.json

@@ -8,6 +8,12 @@
               "/${VERSION}/recommended-production-settings.html"
             ]
         },
+        {
+            "title": "Deployment and Operations Skills Taxonomy",
+            "urls": [
+              "/${VERSION}/deployment-operations-skills-taxonomy.html"
+            ]
+        },
         {
             "title": "Deploy Locally",
             "items": [

src/current/_includes/v24.3/sidebar-data/self-hosted-deployments.json

@@ -8,6 +8,12 @@
               "/${VERSION}/recommended-production-settings.html"
             ]
         },
+        {
+            "title": "Deployment and Operations Skills Taxonomy",
+            "urls": [
+              "/${VERSION}/deployment-operations-skills-taxonomy.html"
+            ]
+        },
         {
             "title": "Deploy Locally",
             "items": [

src/current/_includes/v25.1/sidebar-data/self-hosted-deployments.json

@@ -8,6 +8,12 @@
               "/${VERSION}/recommended-production-settings.html"
             ]
         },
+        {
+            "title": "Deployment and Operations Skills Taxonomy",
+            "urls": [
+              "/${VERSION}/deployment-operations-skills-taxonomy.html"
+            ]
+        },
         {
             "title": "Deploy Locally",
             "items": [

src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json

@@ -8,6 +8,12 @@
               "/${VERSION}/recommended-production-settings.html"
             ]
         },
+        {
+            "title": "Deployment and Operations Skills Taxonomy",
+            "urls": [
+              "/${VERSION}/deployment-operations-skills-taxonomy.html"
+            ]
+        },
         {
             "title": "Deploy Locally",
             "items": [

src/current/v23.1/deployment-operations-skills-taxonomy.md

@@ -0,0 +1,93 @@
+---
+title: Deployment & Operations Skills Taxonomy
+summary: Learn the foundational skills required to deploy and operate CockroachDB
+toc: true
+docs_area: deploy
+---
+
+This document outlines the foundational skills required to deploy and operate CockroachDB in production environments.
+
+The skills are organized into sections based on the following operational domains:
+
+- [Infrastructure configuration](#infrastructure-configuration)
+- [Security](#security)
+- [Cluster maintenance](#cluster-maintenance)
+- [Troubleshooting](#troubleshooting)
+- [Disaster recovery](#disaster-recovery)
+
+Each section includes links to relevant documentation for the listed skills.
+
+{{site.data.alerts.callout_success}}
+Cockroach Labs offers [Professional Services](https://www.cockroachlabs.com/company/professional-services/) that can assist you with getting applications into production faster and more efficiently.
+{{site.data.alerts.end}}
+
+## Infrastructure configuration
+
+This section covers how to ensure that your hardware and network are properly configured to meet the performance and connectivity requirements of CockroachDB.
+
+- [Verify vCPU, RAM, storage, and disk IOPS performance]({% link {{ page.version.version }}/recommended-production-settings.md %}#hardware)
+- [Configure time synchronization with NTP server]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}#step-1-synchronize-clocks)
+- [Validate network connectivity]({% link {{ page.version.version }}/known-limitations.md %}#cockroachdb-does-not-test-for-all-connection-failure-scenarios)
+
+## Security
+
+This section covers how to secure a CockroachDB deployment, including certificate management, load balancing setup, role-based access control, and data encryption.
+
+- [Create and distribute certificates; initialize cluster]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}#step-2-generate-certificates)
+- [Configure load balancer and direct a workload]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}#step-6-set-up-load-balancing)
+- [Configure RBAC]({% link {{ page.version.version }}/security-reference/authorization.md %})
+- [Encryption at rest]({% link {{ page.version.version }}/encryption.md %})
+
+## Cluster maintenance
+
+This section covers how to manage the lifecycle of CockroachDB nodes, including adding and removing nodes, handling outages, performing upgrades or downgrades, and modifying cluster settings.
+
+- [Shut down a node gracefully]({% link {{ page.version.version }}/node-shutdown.md %})
+- [Handle unplanned node outages]({% link {{ page.version.version }}/recommended-production-settings.md %}#load-balancing)
+- [Add nodes]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster)
+- [Remove nodes]({% link {{ page.version.version }}/node-shutdown.md %}?filters=decommission#remove-nodes)
+- [Add a region]({% link {{ page.version.version }}/alter-database.md %}#add-regions-to-a-database)
+- [Remove a region]({% link {{ page.version.version }}/alter-database.md %}#drop-region)
+- [Rolling upgrades]({% link {{ page.version.version }}/upgrade-cockroach-version.md %})
+- Downgrade a cluster from a [patch or major version]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#step-5-roll-back-the-upgrade-optional)
+- [Change a cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#change-a-cluster-setting)
+- Repave a cluster: cluster repaving involves the following individual skills, which are also used during [rolling upgrades]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}):
+    1. [Shut down a node gracefully]({% link {{ page.version.version }}/node-shutdown.md %})
+    1. Detach the [persistent volume]({% link {{ page.version.version }}/kubernetes-overview.md %}#kubernetes-terminology) (a.k.a. persistent disk) from the removed node's virtual machine (VM) (this step is optional but recommended)
+    1. Delete the removed node's VM
+    1. Start a new VM
+    1. Reattach the persistent disk to the new VM (necessary if you did step #2)
+    1. [Add a node to the cluster]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster) from the new VM
+
+## Troubleshooting
+
+This section contains a list of common issues related to SQL performance, cluster stability, memory usage, load balancing, and changefeed lag.
+
+- [SQL response time for specific queries]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}#query-issues)
+- [SQL throughput degradation across the board]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}#low-throughput)
+- [Cluster instability: Dead/suspect nodes]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#node-liveness-issues)
+- [Out of memory (OOM) problems]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#out-of-memory-oom-crash)
+- [Imbalanced cluster load]({% link {{ page.version.version }}/architecture/replication-layer.md %}#load-based-replica-rebalancing)
+- [End of file (EOF) errors]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#client-connection-issues)
+- [Changefeed is falling behind]({% link {{ page.version.version }}/advanced-changefeed-configuration.md %}#lagging-ranges)
+- [Gather diagnostic data from a "debug zip" file]({% link {{ page.version.version }}/cockroach-debug-zip.md %})
+- [Collect timeseries diagnostic data from a "tsdump" file]({% link {{ page.version.version }}/cockroach-debug-tsdump.md %})
+
+## Disaster recovery
+
+This section covers how to set up and manage backup and restore of your cluster to ensure data recovery in case of failures.
+
+- [Create AWS IAM access key]({% link {{ page.version.version }}/cloud-storage-authentication.md %})
+- [Create S3 bucket for backup data]({% link {{ page.version.version }}/use-cloud-storage.md %}#amazon-s3-storage-classes)
+- [Full cluster backup to S3]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups)
+- [Incremental backup to S3]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups)
+- [Cluster restore from AWS S3]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster)
+
+## See also
+
+- [Production Checklist]({% link {{ page.version.version }}/recommended-production-settings.md %})
+- [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %})
+- [Deploy a Local Cluster from Binary (Secure)]({% link {{ page.version.version }}/secure-a-cluster.md %})
+- [SQL Performance Best Practices]({% link {{ page.version.version }}/performance-best-practices-overview.md %})
+- [Performance Tuning Recipes]({% link {{ page.version.version }}/performance-recipes.md %})
+- [Troubleshoot Self-Hosted Setup]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %})

src/current/v23.2/deployment-operations-skills-taxonomy.md

@@ -0,0 +1,93 @@
+---
+title: Deployment & Operations Skills Taxonomy
+summary: Learn the foundational skills required to deploy and operate CockroachDB
+toc: true
+docs_area: deploy
+---
+
+This document outlines the foundational skills required to deploy and operate CockroachDB in production environments.
+
+The skills are organized into sections based on the following operational domains:
+
+- [Infrastructure configuration](#infrastructure-configuration)
+- [Security](#security)
+- [Cluster maintenance](#cluster-maintenance)
+- [Troubleshooting](#troubleshooting)
+- [Disaster recovery](#disaster-recovery)
+
+Each section includes links to relevant documentation for the listed skills.
+
+{{site.data.alerts.callout_success}}
+Cockroach Labs offers [Professional Services](https://www.cockroachlabs.com/company/professional-services/) that can assist you with getting applications into production faster and more efficiently.
+{{site.data.alerts.end}}
+
+## Infrastructure configuration
+
+This section covers how to ensure that your hardware and network are properly configured to meet the performance and connectivity requirements of CockroachDB.
+
+- [Verify vCPU, RAM, storage, and disk IOPS performance]({% link {{ page.version.version }}/recommended-production-settings.md %}#hardware)
+- [Configure time synchronization with NTP server]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}#step-1-synchronize-clocks)
+- [Validate network connectivity]({% link {{ page.version.version }}/known-limitations.md %}#cockroachdb-does-not-test-for-all-connection-failure-scenarios)
+
+## Security
+
+This section covers how to secure a CockroachDB deployment, including certificate management, load balancing setup, role-based access control, and data encryption.
+
+- [Create and distribute certificates; initialize cluster]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}#step-2-generate-certificates)
+- [Configure load balancer and direct a workload]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}#step-6-set-up-load-balancing)
+- [Configure RBAC]({% link {{ page.version.version }}/security-reference/authorization.md %})
+- [Encryption at rest]({% link {{ page.version.version }}/encryption.md %})
+
+## Cluster maintenance
+
+This section covers how to manage the lifecycle of CockroachDB nodes, including adding and removing nodes, handling outages, performing upgrades or downgrades, and modifying cluster settings.
+
+- [Shut down a node gracefully]({% link {{ page.version.version }}/node-shutdown.md %})
+- [Handle unplanned node outages]({% link {{ page.version.version }}/recommended-production-settings.md %}#load-balancing)
+- [Add nodes]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster)
+- [Remove nodes]({% link {{ page.version.version }}/node-shutdown.md %}?filters=decommission#remove-nodes)
+- [Add a region]({% link {{ page.version.version }}/alter-database.md %}#add-regions-to-a-database)
+- [Remove a region]({% link {{ page.version.version }}/alter-database.md %}#drop-region)
+- [Rolling upgrades]({% link {{ page.version.version }}/upgrade-cockroach-version.md %})
+- Downgrade a cluster from a [patch or major version]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#step-5-roll-back-the-upgrade-optional)
+- [Change a cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#change-a-cluster-setting)
+- Repave a cluster: cluster repaving involves the following individual skills, which are also used during [rolling upgrades]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}):
+    1. [Shut down a node gracefully]({% link {{ page.version.version }}/node-shutdown.md %})
+    1. Detach the [persistent volume]({% link {{ page.version.version }}/kubernetes-overview.md %}#kubernetes-terminology) (a.k.a. persistent disk) from the removed node's virtual machine (VM) (this step is optional but recommended)
+    1. Delete the removed node's VM
+    1. Start a new VM
+    1. Reattach the persistent disk to the new VM (necessary if you did step #2)
+    1. [Add a node to the cluster]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster) from the new VM
+
+## Troubleshooting
+
+This section contains a list of common issues related to SQL performance, cluster stability, memory usage, load balancing, and changefeed lag.
+
+- [SQL response time for specific queries]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}#query-issues)
+- [SQL throughput degradation across the board]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}#low-throughput)
+- [Cluster instability: Dead/suspect nodes]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#node-liveness-issues)
+- [Out of memory (OOM) problems]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#out-of-memory-oom-crash)
+- [Imbalanced cluster load]({% link {{ page.version.version }}/architecture/replication-layer.md %}#load-based-replica-rebalancing)
+- [End of file (EOF) errors]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#client-connection-issues)
+- [Changefeed is falling behind]({% link {{ page.version.version }}/advanced-changefeed-configuration.md %}#lagging-ranges)
+- [Gather diagnostic data from a "debug zip" file]({% link {{ page.version.version }}/cockroach-debug-zip.md %})
+- [Collect timeseries diagnostic data from a "tsdump" file]({% link {{ page.version.version }}/cockroach-debug-tsdump.md %})
+
+## Disaster recovery
+
+This section covers how to set up and manage backup and restore of your cluster to ensure data recovery in case of failures.
+
+- [Create AWS IAM access key]({% link {{ page.version.version }}/cloud-storage-authentication.md %})
+- [Create S3 bucket for backup data]({% link {{ page.version.version }}/use-cloud-storage.md %}#amazon-s3-storage-classes)
+- [Full cluster backup to S3]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups)
+- [Incremental backup to S3]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups)
+- [Cluster restore from AWS S3]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster)
+
+## See also
+
+- [Production Checklist]({% link {{ page.version.version }}/recommended-production-settings.md %})
+- [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %})
+- [Deploy a Local Cluster from Binary (Secure)]({% link {{ page.version.version }}/secure-a-cluster.md %})
+- [SQL Performance Best Practices]({% link {{ page.version.version }}/performance-best-practices-overview.md %})
+- [Performance Tuning Recipes]({% link {{ page.version.version }}/performance-recipes.md %})
+- [Troubleshoot Self-Hosted Setup]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %})