Merge remote-tracking branch 'origin/main' into kubedocs

# Conflicts: # src/pages/docs/deployments/kubernetes/deploy-raw-yaml/index.md # src/pages/docs/deployments/kubernetes/helm-update/index.md # src/pages/docs/deployments/kubernetes/kustomize/index.mdx
OctopusDeploy · Jul 29, 2024 · 97aecb2 · 97aecb2
2 parents 5571fbb + fe34494
commit 97aecb2
Show file tree

Hide file tree

Showing 494 changed files with 22,237 additions and 7,016 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -7,6 +7,10 @@
 
 /.github/CODEOWNERS @steve-fenton-octopus @tonykelly-octopus
 
+# Owners of the dictionary-octopus.txt file
+
+/dictionary-octopus.txt @steve-fenton-octopus
+
 # credits updates get reviewed by michaelnoonan and jburger for open source license compliance
 
 /docs/credits.md @michaelnoonan @jburger
@@ -179,9 +183,9 @@
 
 /docs/packaging-applications/create-packages/index.md @OctopusDeploy/team-server-at-scale
 
-# updates to the packaging applications builder servers page are reviewed by team-server-at-scale
+# updates to the packaging applications builder servers page are reviewed by team-modern-deployments
 
-/docs/packaging-applications/build-servers/index.md @OctopusDeploy/team-server-at-scale
+/docs/packaging-applications/build-servers/index.md @OctopusDeploy/team-modern-deployments
 
 # updates to the packaging applications packaging repositories page are reviewed by team-server-at-scale
 
@@ -355,9 +359,9 @@
 
 /docs/octopus-rest-api/cli/ @OctopusDeploy/team-modern-deployments
 
-# updates to the openid connect page are reviewed by team-github
+# updates to the openid connect page are reviewed by team-devex
 
-/docs/octopus-rest-api/openid-connect/index.md @OctopusDeploy/team-github
+/docs/octopus-rest-api/openid-connect/index.md @OctopusDeploy/team-devex
 
 # updates to the administration section are reviewed by team-backend-foundations
 
@@ -446,3 +450,9 @@
 # updates to the deprecations page are reviewed by michaelnoonan and alexrolleyoctopus
 
 /docs/deprecations/index.md @michaelnoonan @alexrolleyoctopus
+
+# updates to the Kubernetes targets infrastructure pages are reviewed by modern-deployments
+
+/docs/infrastructure/deployment-targets/kubernetes @OctopusDeploy/team-modern-deployments
+/docs/infrastructure/deployment-targets/kubernetes-cluster @OctopusDeploy/team-modern-deployments
+/docs/infrastructure/deployment-targets/kubernetes-target @OctopusDeploy/team-modern-deployments
diff --git a/.github/workflows/branch-spellcheck.yml b/.github/workflows/branch-spellcheck.yml
@@ -7,45 +7,40 @@ permissions:
   contents: read
   id-token: write
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   spellcheck:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
+        uses: actions/checkout@v4
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
-          version: 8.7.0
+          version: 9.1.0
           run_install: false
 
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - uses: actions/cache@v3
-        name: Setup pnpm cache
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
 
-      - name: PNPM and Playwright install
+      - name: PNPM install
         run: |
           echo; echo "cd to workspace"
           cd $GITHUB_WORKSPACE
           echo; echo "listing"
           ls
-          echo; echo "NPM install"
+          echo; echo "PNPM install"
           pnpm install
 
       - name: Check spellings

diff --git a/.github/workflows/branch-validation.yml b/.github/workflows/branch-validation.yml
@@ -8,9 +8,15 @@ permissions:
   pages: write
   id-token: write
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  build:
+  branch_tests:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
 
     env:
       SHOULD_DEPLOY: ${{ secrets.OCTOPUSSERVERURL != '' || '' }}
@@ -20,31 +26,21 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
-          version: 8.7.0
+          version: 9.1.0
           run_install: false
 
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - uses: actions/cache@v3
-        name: Setup pnpm cache
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
 
       - name: PNPM and Playwright install
         run: |
@@ -110,4 +106,4 @@ jobs:
         with:
           project: "Docs Microsite"
           package_version: "${{ env.PACKAGE_VERSION }}-pullrequest"
-          git_ref: ${{ github.ref }}
+          git_ref: ${{ github.ref }}
diff --git a/.github/workflows/build-astro.yml b/.github/workflows/build-astro.yml
@@ -12,9 +12,15 @@ permissions:
   pages: write
   id-token: write
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  build:
+  build_and_deploy:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
 
     env:
       SHOULD_DEPLOY: ${{ secrets.OCTOPUSSERVERURL != '' || '' }}
@@ -24,31 +30,20 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
+        uses: actions/checkout@v4
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
-          version: 8.7.0
+          version: 9.1.0
           run_install: false
 
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - uses: actions/cache@v3
-        name: Setup pnpm cache
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
 
       - name: PNPM and Playwright install
         run: |
@@ -114,4 +109,4 @@ jobs:
         with:
           project: "Docs Microsite"
           package_version: "${{ env.PACKAGE_VERSION }}"
-          git_ref: ${{ github.ref }}
+          git_ref: ${{ github.ref }}
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,12 @@
 # build output
 dist/
+.astro/
 .cache/
 .log/
 
+# package lock
+package-lock.json
+
 # dependencies
 node_modules/
 

diff --git a/.npmrc b/.npmrc
@@ -1,2 +1,3 @@
 # Expose Astro dependencies for `pnpm` users
-shamefully-hoist=true
+shamefully-hoist=true
+package-manager-strict=false
diff --git a/.octopus/deployment_process.ocl b/.octopus/deployment_process.ocl
@@ -6,27 +6,81 @@ step "upload-microsite-to-aws-s3" {
         is_required = true
         properties = {
             Octopus.Action.Aws.AssumeRole = "False"
-            Octopus.Action.Aws.Region = "#{AWS.Region.Docs}"
-            Octopus.Action.Aws.S3.BucketName = "#{AWS.BucketName.Docs}"
-            Octopus.Action.Aws.S3.FileSelections = "[{\"type\":\"MultipleFiles\",\"tags\":[],\"metadata\":[{\"key\":\"Cache-Control\",\"value\":\"public, max-age=604800\"}],\"cannedAcl\":\"public-read\",\"path\":\"\",\"storageClass\":\"STANDARD\",\"bucketKey\":\"\",\"bucketKeyPrefix\":\"\",\"bucketKeyBehaviour\":\"Custom\",\"performVariableSubstitution\":\"False\",\"performStructuredVariableSubstitution\":\"False\",\"autoFocus\":true,\"pattern\":\"**/*\"}]"
+            Octopus.Action.Aws.Region = "#{AWS.Region}"
+            Octopus.Action.Aws.S3.BucketName = "#{AWS.BucketName}"
+            Octopus.Action.Aws.S3.FileSelections = "[{\"type\":\"MultipleFiles\",\"tags\":[],\"metadata\":[{\"key\":\"Cache-Control\",\"value\":\"604800\"}],\"cannedAcl\":\"public-read\",\"path\":\"\",\"storageClass\":\"STANDARD\",\"bucketKey\":\"\",\"bucketKeyPrefix\":\"\",\"bucketKeyBehaviour\":\"Custom\",\"performVariableSubstitution\":\"False\",\"performStructuredVariableSubstitution\":\"False\",\"autoFocus\":true,\"pattern\":\"**/*\"}]"
             Octopus.Action.Aws.S3.PackageOptions = "{\"bucketKey\":\"#{Project.AWS.BucketKey}\",\"bucketKeyBehaviour\":\"Custom\",\"bucketKeyPrefix\":\"\",\"storageClass\":\"STANDARD\",\"cannedAcl\":\"private\",\"variableSubstitutionPatterns\":\"\",\"structuredVariableSubstitutionPatterns\":\"\",\"metadata\":[],\"tags\":[]}"
             Octopus.Action.Aws.S3.TargetMode = "FileSelections"
             Octopus.Action.AwsAccount.UseInstanceRole = "False"
             Octopus.Action.AwsAccount.Variable = "AWS.Account"
             Octopus.Action.Package.DownloadOnTentacle = "False"
             Octopus.Action.Package.FeedId = "octopus-server-built-in"
-            Octopus.Action.Package.PackageId = "DocsMicrosite"
-            Octopus.Action.RunOnServer = "true"
+            Octopus.Action.Package.PackageId = "#{PackageId}"
         }
         worker_pool = "hosted-ubuntu"
 
         packages {
             acquisition_location = "Server"
             feed = "octopus-server-built-in"
-            package_id = "DocsMicrosite"
+            package_id = "#{PackageId}"
             properties = {
                 SelectionMode = "immediate"
             }
         }
     }
+}
+
+step "clear-aws-cloudfront-cache" {
+    name = "Clear AWS CloudFront Cache"
+
+    action {
+        action_type = "Octopus.AwsRunScript"
+        properties = {
+            Octopus.Action.Aws.AssumeRole = "False"
+            Octopus.Action.Aws.Region = "#{AWS.Region}"
+            Octopus.Action.AwsAccount.UseInstanceRole = "False"
+            Octopus.Action.AwsAccount.Variable = "CloudFront.InvalidationAccount"
+            Octopus.Action.Script.ScriptBody = <<-EOT
+                aws cloudfront create-invalidation \
+                --distribution-id #{AWS.Distribution} \
+                --paths "/*"
+                EOT
+            Octopus.Action.Script.ScriptSource = "Inline"
+            Octopus.Action.Script.Syntax = "Bash"
+            OctopusUseBundledTooling = "False"
+        }
+        worker_pool = "hosted-ubuntu"
+
+        container {
+            feed = "docker-hub"
+            image = "octopusdeploy/worker-tools:6.2.1-ubuntu.22.04"
+        }
+    }
+}
+
+step "slack-notify-feed-website-automation" {
+    condition = "Always"
+    name = "Slack - Notify #feed-website-automation"
+
+    action {
+        properties = {
+            Channel = "#feed-website-automation"
+            DeploymentInfoText = "#{Octopus.Project.Name} release #{Octopus.Release.Number} to #{Octopus.Environment.Name} #{AWS.Website}"
+            HookUrl = "#{FeedWebsiteAutomation.WebHook}"
+            IconUrl = "https://octopus.com/content/resources/favicon.png"
+            IncludeErrorMessageOnFailure = "false"
+            IncludeFieldEnvironment = "True"
+            IncludeFieldMachine = "false"
+            IncludeFieldRelease = "True"
+            IncludeFieldReleaseNotes = "false"
+            IncludeFieldTenant = "false"
+            IncludeFieldUsername = "false"
+            IncludeLinkOnFailure = "True"
+            Octopus.Action.Template.Id = "ActionTemplates-181"
+            Octopus.Action.Template.Version = "10"
+            OctopusBaseUrl = "https://tenpillars.octopus.app"
+            Username = "Octopus Deploy"
+        }
+        worker_pool = "hosted-ubuntu"
+    }
 }
diff --git a/.octopus/schema_version.ocl b/.octopus/schema_version.ocl
@@ -1 +1 @@
-version = 6
+version = 8
diff --git a/.octopus/variables.ocl b/.octopus/variables.ocl
@@ -0,0 +1,37 @@
+variable "AWS.Website" {
+    value "http://octopus-docs-production.s3-website-us-east-1.amazonaws.com/docs" {
+        environment = ["live"]
+    }
+
+    value "http://octopus-docs-staging.s3-website-us-east-1.amazonaws.com/docs" {
+        environment = ["test"]
+    }
+}
+
+variable "AWS.Region" {
+    value "us-east-1" {}
+}
+
+variable "AWS.Distribution" {
+    value "E1M91AW6ZECI94" {
+        environment = ["live"]
+    }
+
+    value "E2ABBGFOMEE5DL" {
+        environment = ["test"]
+    }
+}
+
+variable "AWS.BucketName" {
+    value "octopus-docs-production" {
+        environment = ["live"]
+    }
+
+    value "octopus-docs-staging" {
+        environment = ["test"]
+    }
+}
+
+variable "PackageId" {
+    value "DocsMicrosite" {}
+}