Merge branch 'main' into kubedocs

OctopusDeploy · Jul 30, 2024 · 82d4f19 · 82d4f19
2 parents 50050ce + 9a5acb0
commit 82d4f19
Show file tree

Hide file tree

Showing 44 changed files with 22 additions and 19 deletions.
diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt
@@ -386,6 +386,7 @@ websockets
 WEBSVR
 WFLYUT
 Wildfly
+Wireshark
 WIXUI
 workerpool
 workerpools

diff --git a/public/docs/approvals/jira-task-settings.png b/public/docs/approvals/jira-task-settings.png
diff --git a/public/docs/concepts/images/environments.png b/public/docs/concepts/images/environments.png
diff --git a/public/docs/concepts/images/projects.png b/public/docs/concepts/images/projects.png
diff --git a/public/docs/deployments/octopus-step-templates.png b/public/docs/deployments/octopus-step-templates.png
diff --git a/public/docs/getting-started/dashboard.png b/public/docs/getting-started/dashboard.png
diff --git a/...docs/getting-started/first-runbook-run/images/run-deployment-target-results.png b/...docs/getting-started/first-runbook-run/images/run-deployment-target-results.png
diff --git a/public/docs/getting-started/first-runbook-run/images/run-hello-runbook-results.png b/public/docs/getting-started/first-runbook-run/images/run-hello-runbook-results.png
diff --git a/public/docs/getting-started/first-runbook-run/images/run-runbook-basic-options.png b/public/docs/getting-started/first-runbook-run/images/run-runbook-basic-options.png
diff --git a/...s/getting-started/first-runbook-run/images/run-runbook-post-publish-changes.png b/...s/getting-started/first-runbook-run/images/run-runbook-post-publish-changes.png
diff --git a/...cs/getting-started/first-runbook-run/images/run-script-on-deployment-target.png b/...cs/getting-started/first-runbook-run/images/run-script-on-deployment-target.png
diff --git a/public/docs/getting-started/first-runbook-run/images/runbook-overview.png b/public/docs/getting-started/first-runbook-run/images/runbook-overview.png
diff --git a/public/docs/getting-started/first-runbook-run/images/runbook-process.png b/public/docs/getting-started/first-runbook-run/images/runbook-process.png
diff --git a/...ic/docs/getting-started/first-runbook-run/images/runbook-run-with-variables.png b/...ic/docs/getting-started/first-runbook-run/images/runbook-run-with-variables.png
diff --git a/public/docs/getting-started/first-runbook-run/images/variables.png b/public/docs/getting-started/first-runbook-run/images/variables.png
diff --git a/public/docs/infrastructure/images/infrastructure-overview-dashboard.png b/public/docs/infrastructure/images/infrastructure-overview-dashboard.png
diff --git a/public/docs/insights/images/overview.png b/public/docs/insights/images/overview.png
diff --git a/public/docs/projects/octopus-project-group.png b/public/docs/projects/octopus-project-group.png
diff --git a/public/docs/projects/octopus-projects-list.png b/public/docs/projects/octopus-projects-list.png
diff --git a/public/docs/releases/octopus-releases-overview.png b/public/docs/releases/octopus-releases-overview.png
diff --git a/public/docs/runbooks/create-a-runbook.png b/public/docs/runbooks/create-a-runbook.png
diff --git a/public/docs/runbooks/runbooks-screen.png b/public/docs/runbooks/runbooks-screen.png
diff --git a/public/docs/shared-content/concepts/images/deployment-process.png b/public/docs/shared-content/concepts/images/deployment-process.png
diff --git a/public/docs/shared-content/concepts/images/environments.png b/public/docs/shared-content/concepts/images/environments.png
diff --git a/public/docs/shared-content/concepts/images/infrastructure.png b/public/docs/shared-content/concepts/images/infrastructure.png
diff --git a/public/docs/shared-content/concepts/images/projects.png b/public/docs/shared-content/concepts/images/projects.png
diff --git a/public/docs/shared-content/concepts/images/variables.png b/public/docs/shared-content/concepts/images/variables.png
diff --git a/public/docs/tenants/images/octopus-tenants-deployments.png b/public/docs/tenants/images/octopus-tenants-deployments.png
diff --git a/src/pages/docs/deployments/index.mdx b/src/pages/docs/deployments/index.mdx
@@ -30,7 +30,7 @@ The Octopus [deployment process](/docs/projects/deployment-process/) lets you de
 Critically, unlike a manual checklist, Octopus never forgets to run a step and always completes them in the correct order.
 
 :::figure
-![Octopus deployment process](/docs/deployments/octopus-deployment-process.png)
+![Octopus deployment process](/docs/shared-content/concepts/images/deployment-process.png)
 :::
 
 ### Steps
@@ -54,7 +54,7 @@ When switched on, step retries re-attempts to run the failed step 3 times before
 Octopus [variables](/docs/projects/variables/) let you apply the correct variables easily during a deployment. Octopus can manage simple values, secrets, and accounts as variables.
 
 :::figure
-![Octopus variables](/docs/deployments/octopus-variables.png)
+![Octopus variables](/docs/shared-content/concepts/images/variables.png)
 :::
 
 You can scope variables by:

diff --git a/...s/docs/getting-started/first-deployment/legacy-guide/configure-environments.mdx b/...s/docs/getting-started/first-deployment/legacy-guide/configure-environments.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Configure Environments
 description: Step by step guide on how to configure environments in Octopus Deploy
 navOrder: 10

diff --git a/...pages/docs/getting-started/first-runbook-run/add-runbook-deployment-targets.mdx b/...pages/docs/getting-started/first-runbook-run/add-runbook-deployment-targets.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Add runbook deployment targets
 description: Step by step guide on how to add deployment targets for runbooks in Octopus Deploy.
 navOrder: 70

diff --git a/...pages/docs/getting-started/first-runbook-run/configure-runbook-environments.mdx b/...pages/docs/getting-started/first-runbook-run/configure-runbook-environments.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Configure Runbook Environments
 description: Step by step guide on how to configure environments in Octopus Deploy.
 navOrder: 10

diff --git a/src/pages/docs/getting-started/first-runbook-run/create-a-runbook.md b/src/pages/docs/getting-started/first-runbook-run/create-a-runbook.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Create a runbook
 description: Step by step guide on how to create a runbook in Octopus Deploy.
 navOrder: 30

diff --git a/src/pages/docs/getting-started/first-runbook-run/create-runbook-projects.mdx b/src/pages/docs/getting-started/first-runbook-run/create-runbook-projects.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Create a Project
 description: Step by step guide on how to create projects in Octopus Deploy.
 navOrder: 20

diff --git a/...ocs/getting-started/first-runbook-run/define-the-runbook-process-for-targets.md b/...ocs/getting-started/first-runbook-run/define-the-runbook-process-for-targets.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-04-19
+modDate: 2024-07-30
 title: Defining the runbook process for targets
 description: Step by step guide on how to define a runbook process in Octopus Deploy.
 navOrder: 80

diff --git a/src/pages/docs/getting-started/first-runbook-run/define-the-runbook-process.md b/src/pages/docs/getting-started/first-runbook-run/define-the-runbook-process.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Defining the runbook process for workers
 description: Step by step guide on how to define a runbook process to run on Workers in Octopus Deploy.
 navOrder: 40

diff --git a/src/pages/docs/getting-started/first-runbook-run/index.mdx b/src/pages/docs/getting-started/first-runbook-run/index.mdx
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: First Runbook Run
 description: This section will walk you through how to configure your first runbook run in Octopus Deploy.
 navOrder: 20

diff --git a/src/pages/docs/getting-started/first-runbook-run/publishing-a-runbook.md b/src/pages/docs/getting-started/first-runbook-run/publishing-a-runbook.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Publishing a runbook
 description: Step by step guide on how to publish an Octopus Deploy Runbook to use with triggers.
 navOrder: 90

diff --git a/src/pages/docs/getting-started/first-runbook-run/runbook-specific-variables.md b/src/pages/docs/getting-started/first-runbook-run/runbook-specific-variables.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Runbook specific variables
 description: Step by step guide on how to define and use variables in an Octopus Deploy runbook.
 navOrder: 60

diff --git a/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md b/src/pages/docs/getting-started/first-runbook-run/running-a-runbook.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-07-30
 title: Running a Runbook
 description: Step by step guide on how to run a runbook in Octopus Deploy.
 navOrder: 50

diff --git a/...es/docs/infrastructure/deployment-targets/tentacle/troubleshooting-tentacles.md b/...es/docs/infrastructure/deployment-targets/tentacle/troubleshooting-tentacles.md
@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-07-19
+modDate: 2024-07-29
 title: Troubleshooting Tentacles
 description: How to troubleshoot problems with Octopus Tentacles.
 navOrder: 60
@@ -262,3 +262,7 @@ Server-side:`System.IO.IOException: Unable to read data from the transport conne
 **Halibut.Transport.Protocol.ConnectionInitializationFailedException: Unable to process remote identity; unknown identity 'HTTP/1.0'**
 
 If a Tentacle health-check fails with an error message containing this error message, then there is network infrastructure inserting a web page into the communication.  The most common components to do this are firewalls and proxy servers so it's recommend to check your network setup to verify connectivity between the two servers using the information above and then update your infrastructure appropriately.
+
+**Halibut.HalibutClientException: An error occurred when sending a request to 'https://my-tentacle:10933', before the request could begin: Attempted to read past the end of the stream.**
+
+If your Octopus server certificate was [generated with SHA1](/docs/security/cve/shattered-and-octopus-deploy) then you might get this error when connecting to modern Linux distributions, as the default security configuration now rejects communication using SHA1. To regenerate your Octopus server certificate, follow the documentation [How to regenerate certificates with Octopus Server and Tentacle](/docs/security/octopus-tentacle-communication/regenerate-certificates-with-octopus-server-and-tentacle).
diff --git a/src/pages/docs/projects/variables/variable-filters.md b/src/pages/docs/projects/variables/variable-filters.md
@@ -86,7 +86,7 @@ The *Replace* filter performs a regular expression replace function on the varia
 | `abc`       | `#{MyVar \| Replace "(.)b(.)" "$2X$1" }`  | `cXa`                                      |
 | `abc`       | `#{MyVar \| Replace #{match} #{replace}}` | `a_c` (when `match`=`b` and `replace`=`_`) |
 | `abc`       | `#{MyVar \| Replace #{match} _}`          | `a_c` (when `match`=`b`)                   |
-| `a\b`       | `#{MyVar \| Replace "\\" "\\"}`           | `a\\b`                                     |
+| `a\b`       | `#{MyVar \| Replace "\\" "\\\\"}`         | `a\\b`                                     |
 
 
 ### Substring

diff --git a/src/pages/docs/runbooks/index.mdx b/src/pages/docs/runbooks/index.mdx
@@ -46,9 +46,7 @@ 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 **Project ➜ Operations ➜ Runbooks ➜ Add Runbook**.
-
-To create a runbook, navigate to **Project ➜ Operations ➜ Runbooks ➜ Add Runbook**.
+Runbooks belong to projects. To create or manage your runbooks, navigate to **Deploy ➜ Runbooks ➜ Add Runbook**.
 
 :::figure
 ![Add Runbook](/docs/runbooks/create-a-runbook.png)

diff --git a/src/shared-content/installation/octopus-server.include.md b/src/shared-content/installation/octopus-server.include.md
@@ -3,7 +3,7 @@ The Octopus Server is the deployment automation server where you define your dep
 The Octopus Server includes the Octopus Rest API and the Octopus Web Portal.
 
 :::figure
-![Octopus Dashboard](/docs/shared-content/concepts/images/dashboard.png)
+![Octopus Dashboard](/docs/getting-started/dashboard.png)
 :::
 
 You can use the Octopus REST API or the Octopus Web Portal to design your deployment processes and your releases, connect to the servers, services, and accounts where your software will be deployed, and to use runbooks to automate routine maintenance and emergency operations tasks like infrastructure provisioning, database management, and website failover and restoration.