Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ appsettings
Appstep
Appsteps
argparse
askpass
asax
ASPNET
aspnetcore
Expand Down Expand Up @@ -112,6 +113,7 @@ Directorygroup
DISM
Distro
distros
Djava
Dockerfiles
dockerhub
Domainname
Expand Down Expand Up @@ -413,6 +415,7 @@ replicasets
reprioritize
reprovisioned
reprovisioning
requiretty
resolv.conf
ResolvConfPath
RHEV
Expand Down Expand Up @@ -512,6 +515,7 @@ thepassword
timespan
tlsv1
tmpfs
tomcatadmin
Toolbelt
Toolsets
Topshelf
Expand All @@ -531,6 +535,7 @@ updateprogress
upgradeavailability
upgradelog
upgrader
urandom
urllib
urlset
Userns
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/administration/reporting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ If you're using Octopus Cloud, you'll only be able to work with the API for your

## Learn more

- [Reporting blog posts](https://octopus.com/blog/tag/reporting)
- [Reporting blog posts](https://octopus.com/blog/tag/reporting/1)
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ This is due to that the revocation information for the certificate is not retrie

## Learn more

- [Reporting blog posts](https://octopus.com/blog/tag/reporting)
- [Reporting blog posts](https://octopus.com/blog/tag/reporting/1)
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ You may want to look at [enabling HTTP logging](/docs/administration/managing-in

## Learn more

- [Reporting blog posts](https://octopus.com/blog/tag/reporting)
- [Reporting blog posts](https://octopus.com/blog/tag/reporting/1)
4 changes: 0 additions & 4 deletions src/pages/docs/administration/retention-policies/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,3 @@ For example, if you have 12 months worth of releases now, perhaps set the retent
## Older versions

From 2023.1, the [audit retention functionality](/docs/security/users-and-teams/auditing/#archived-audit-events) has been rolled out. This **does not** delete audit records. It just moves them from the database to the file system.

## Learn more

- [Retention policy knowledge base articles](https://help.octopus.com/tag/retention)
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/aws/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ Flexible, [role-based security](/docs/security/users-and-teams/user-roles/) allo

## Learn more

- [AWS blog posts](https://octopus.com/blog/tag/aws)
- [AWS blog posts](https://octopus.com/blog/tag/aws/1)
- [AWS runbook examples](/docs/runbooks/runbook-examples/aws)
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/azure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ All steps that target an Azure deployment target (including script steps) execut
## Learn more

- Generate an Octopus guide for [Azure and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?destination=Azure%20websites).
- [Azure blog posts](https://octopus.com/blog/tag/azure).
- [Azure blog posts](https://octopus.com/blog/tag/azure/1).
- [Azure runbook examples](/docs/runbooks/runbook-examples/azure).
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ When you are finished debugging, run to the end of the script and the deployment

## Learn more

- [PowerShell blog posts](https://octopus.com/blog/tag/powershell)
- [PowerShell blog posts](https://octopus.com/blog/tag/powershell/1)
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ add a variable named `Octopus.Action.PowerShell.ExecuteWithoutProfile` with a va

## Learn more

- [PowerShell blog posts](https://octopus.com/blog/tag/powershell)
- [PowerShell blog posts](https://octopus.com/blog/tag/powershell/1)
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ We recommend rolling forward or making your database changes backward compatible

## Learn more

- [Database blog posts](https://octopus.com/blog/tag/database%20deployments)
- [Database blog posts](https://octopus.com/blog/tag/database-deployments/1)
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/databases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ Automating database deployments is often the final piece of a fully automated CI
## Learn more

- [Manage database maintenance with runbooks](/docs/runbooks/runbook-examples/databases)
- [Database blog posts](https://octopus.com/blog/tag/database%20deployments)
- [Database blog posts](https://octopus.com/blog/tag/database-deployments/1)
Original file line number Diff line number Diff line change
Expand Up @@ -302,4 +302,4 @@ The following JSON objects are real outputs from docker inspect commands to prov

## Learn more

- [Docker blog posts](https://octopus.com/blog/tag/docker)
- [Docker blog posts](https://octopus.com/blog/tag/docker/1)
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,4 @@ In the case of our simple scenario above, the final step should display the IP a

## Learn more

- [Docker blog posts](https://octopus.com/blog/tag/docker)
- [Docker blog posts](https://octopus.com/blog/tag/docker/1)
6 changes: 3 additions & 3 deletions src/pages/docs/deployments/docker/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ The Octopus concepts of feeds, packages and versions can be mapped to the Docker

## Learn more

- [Docker blog posts](https://octopus.com/blog/tag/docker)
- [Docker registries as feeds](/docs/packaging-applications/package-repositories/docker-registries)
- [Accessing container details](/docs/deployments/docker/accessing-container-details)
- [Docker blog posts](https://octopus.com/blog/tag/docker/1)
- [Docker registries as feeds](/docs/packaging-applications/package-repositories/docker-registries)
- [Accessing container details](/docs/deployments/docker/accessing-container-details)
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/java/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,6 @@ The Java deployment steps include a number of unique error codes that may be dis
## Learn more

- Generate an Octopus guide for [Java, Tomcat, and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?application=Java&destination=Tomcat).
- [Java blog posts](https://octopus.com/blog/tag/java)
- [Java blog posts](https://octopus.com/blog/tag/java/1)
- [Webinar: Octopus 101: Deploy Your First Java Application](https://www.youtube.com/watch?v=AM6GyYr2n4Y)
- [Install Tomcat Runbook example](/docs/runbooks/runbook-examples/routine/installing-tomcat).
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ You can achieve this kind of result using an NGINX server as a reverse proxy to

- [View Blue/Green deployment examples on our samples instance](https://oc.to/PatternBlueGreenSamplesSpace).
- [Blue/Green deployment knowledge base articles](https://oc.to/BlueGreenTaggedKBArticles).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Configuring your [lifecycle](/docs/releases/lifecycles) will need to be done acc
- [Change load-balancer group Runbook example](/docs/runbooks/runbook-examples/aws/change-load-balancer-group).
- [Blue/Green deployment knowledge base articles](https://oc.to/BlueGreenTaggedKBArticles).
- [Ask Octopus Episode: Blue/Green Deployments](https://www.youtube.com/watch?v=qFqoVwVzeo0)
- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
4 changes: 2 additions & 2 deletions src/pages/docs/deployments/patterns/branching.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ When designing channels in Octopus, don't think about channels as another name f
- **Branches** can be short lived and tend to get merged, and model the way code changes in the system.
- **Channels** are often long lived, and model your release process.

For example, [Google Chrome have four different channels](https://www.chromium.org/getting-involved/dev-channel) (Stable, Beta, Dev, and Canary). Their channels are designed around user's tolerance for bleeding edge features vs. stability. Underneath, they may have many release branches contributing to those channels. You can read about implementing [early-access programs in the Channels Walk-through](https://octopus.com/blog/channels-walkthrough#early-access-programs).
For example, [Google Chrome have four different channels](https://www.chromium.org/getting-involved/dev-channel) (Stable, Beta, Dev, and Canary). Their channels are designed around user's tolerance for bleeding edge features vs. stability. Underneath, they may have many release branches contributing to those channels.

It's important to realize that **branches will map to different channels over time**. For example, right now, packages from the `release/v2` branch might map to your "Stable" channel in Octopus, while packages from `release/v3` go to your "Early Adopter" channel.

Expand Down Expand Up @@ -209,4 +209,4 @@ When creating the release, you can then choose whether the release is for an ind

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Another variation of the canary deployment is to deploy the new version to all s

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,4 @@ If you have thoughts about how deployment as code could better support your orga

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Machine clean up is part of health checks and machine clean up logs are not stor

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns).
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Now that deployment targets can be automatically removed from a deployment, it m

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ $repository.Projects.Modify($project)

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ hideInThisSectionHeader: true

Elastic and transient environments is a group of features to facilitate deploying to machines that are intermittently available for deployment.

## Scenarios {#ElasticandTransientEnvironments-Scenarios}
## Scenarios

### Auto-scaling infrastructure {#ElasticandTransientEnvironments-Auto-scalinginfrastructure}
### Auto-scaling infrastructure

OctoFX has become so popular that additional servers are required to manage peak load. At peak times servers are provisioned and the latest version of OctoFX is deployed to those servers. When demand wanes the additional servers are terminated.

### Intermittent connectivity {#ElasticandTransientEnvironments-Intermittentconnectivity}
### Intermittent connectivity

OctoFX is being deployed to trading desks in offices around the world. Occasionally, unknown to the deployment team, the machines that host OctoFX are taken down for maintenance. OctoFX must be kept up to date when a machine comes back online.

## Elastic and transient environment features {#ElasticandTransientEnvironments-ElasticandTransientEnvironmentfeatures}
## Elastic and transient environment features

- Automatically keep deployment targets up to date with the latest releases.
- Automatically reflect infrastructure changes in your environments.
- Deploy to environments where deployment target status may change during the deployment.

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ With machines now being kept up to date automatically you may be interested in [

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ Tenants offer a balanced approach to modeling multi-region deployments, offering

## Learn more

- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ Octopus will evaluate the value of the [Output variable](/docs/projects/variable
## Learn more
- [View rolling deployment examples on our samples instance](https://oc.to/PatternRollingSamplesSpace).
- [Rolling deployment knowledge base articles](https://oc.to/RollingDeployTaggedKBArticles).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/Deployment%20Patterns).
- [Deployment patterns blog posts](https://octopus.com/blog/tag/deployment-patterns/1).
2 changes: 1 addition & 1 deletion src/pages/docs/infrastructure/accounts/ssh-key-pair.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,4 @@ Due to the number and configurable nature of the various Linux distributions ava

## Learn more

- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ In addition to the .NET 6 requirement, Octopus will only support those Operating

## Learn more

- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,5 @@ Calamari is the tool Octopus uses to execute deployments on a remote computer. B

## Learn more

- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
- [Node.js sample](/docs/deployments/node-js/node-on-linux)
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Octopus can execute Python scripts on SSH targets provided the following criteri
## Learn more

- Configure your [SSH deployment targets](/docs/infrastructure/deployment-targets/linux/ssh-target)
- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ You can use [raw scripting](/docs/deployments/custom-scripts/raw-scripting/) to

## Learn more

- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ in Ubuntu, and in Red Hat:
sudo: sorry you must have a tty to run sudo
```

## Enabling sudo command {#SudoCommands-EnablingSudocommand}
## Enabling sudo command

The recommended way to enable these commands to be run is to disable the password prompt for the user account used for deployments.

### Disable password prompt {#SudoCommands-DisablePasswordPrompt}
### Disable password prompt

Running the following command (from a shell with interactive mode so you can enter any required passwords) adds a file that is read in conjunction with the sudoers file to configure valid sudo policies.

Expand All @@ -51,9 +51,9 @@ Further information regarding how this file is used and how to make the configur
- [sudoers manual](http://www.sudo.ws/man/1.8.13/sudoers.man.html)
- [simple configuration explanation](http://superuser.com/questions/357467/what-do-the-alls-in-the-line-admin-all-all-all-in-ubuntus-etc-sudoers#357472)

If you are using a distro such as Ubuntu, you should now be able to utilize the sudo command throughout your scripts.
If you are using a distro such as Ubuntu, you should now be able to use the sudo command throughout your scripts.

### Disable RequireTTY {#SudoCommands-DisbleRequireTTY}
### Disable RequireTTY

Although the sudo may no longer require a password, some distros, such as Centos and its derivatives, are configured by default to still require interactive input, or tty, when running sudo.

Expand Down Expand Up @@ -84,4 +84,4 @@ While the above instructions should work on common platforms like Ubuntu or RedH

## Learn more

- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
Original file line number Diff line number Diff line change
Expand Up @@ -270,4 +270,4 @@ To harden the TLS implementation used, review our documentation on [Disabling we

## Learn more

- [Linux blog posts](https://octopus.com/blog/tag/linux)
- [Linux blog posts](https://octopus.com/blog/tag/linux/1)
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ Setting the environment variable `DISABLE_DIND` to `Y` prevents Docker-in-Docker

## Learn more

- [Docker blog posts](https://octopus.com/blog/tag/docker)
- [Docker blog posts](https://octopus.com/blog/tag/docker/1)
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Test-DscConfiguration
To review the latest available settings and properties, refer to the [OctopusDSC Tentacle readme.md](https://github.com/OctopusDeploy/OctopusDSC/blob/master/README-cTentacleAgent.md) in the GitHub repository.


DSC can be applied in various ways, such as [Group Policy](https://sdmsoftware.com/group-policy-blog/desired-state-configuration/desired-state-configuration-and-group-policy-come-together/), a [DSC Pull Server](https://docs.microsoft.com/en-us/powershell/scripting/dsc/pull-server/pullserver), [Azure Automation](https://docs.microsoft.com/en-us/azure/automation/automation-dsc-overview), or even via configuration management tools such as [Chef](https://docs.chef.io/resource_dsc_resource.html) or [Puppet](https://github.com/puppetlabs/puppetlabs-dsc). A good resource to learn more about DSC is the [Channel 9 Getting Started with DSC series](https://channel9.msdn.com/Series/Getting-Started-with-PowerShell-DSC).
DSC can be applied in various ways, such as [Group Policy](https://sdmsoftware.com/group-policy-blog/desired-state-configuration/desired-state-configuration-and-group-policy-come-together/), a [DSC Pull Server](https://docs.microsoft.com/en-us/powershell/scripting/dsc/pull-server/pullserver), [Azure Automation](https://docs.microsoft.com/en-us/azure/automation/automation-dsc-overview), or even via configuration management tools such as [Chef](https://docs.chef.io/resources/dsc_resource/) or [Puppet](https://github.com/puppetlabs/puppetlabs-dsc). A good resource to learn more about DSC is the [Channel 9 Getting Started with DSC series](https://channel9.msdn.com/Series/Getting-Started-with-PowerShell-DSC).

For an in depth look, check out the [sample walk-through](/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc) of how to use DSC with an Azure ARM template to deploy and configure the Tentacle on an Azure VM.

Expand Down
3 changes: 1 addition & 2 deletions src/pages/docs/infrastructure/workers/built-in-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,4 @@ You cannot run the Octopus Server as the `Local System` account and successfully

## Learn more

- [Worker blog posts](https://octopus.com/blog/tag/workers)

- [Worker blog posts](https://octopus.com/blog/tag/workers/1)
Original file line number Diff line number Diff line change
Expand Up @@ -171,5 +171,5 @@ If you choose to install additional software on a dynamic worker, you are respon

## Learn more

- [Worker blog posts](https://octopus.com/blog/tag/workers)
- [Worker blog posts](https://octopus.com/blog/tag/workers/1)
- [Worker Tools, versioning and caching](/docs/infrastructure/workers/worker-tools-versioning-and-caching)
2 changes: 1 addition & 1 deletion src/pages/docs/infrastructure/workers/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,5 +200,5 @@ With Octopus High Availability, each node has a task cap and can invoke the buil

## Learn more

- [Worker blog posts](https://octopus.com/blog/tag/workers)
- [Worker blog posts](https://octopus.com/blog/tag/workers/1)
- [Worker pool variables](/docs/projects/variables/worker-pool-variables)
2 changes: 1 addition & 1 deletion src/pages/docs/infrastructure/workers/worker-pools.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,5 @@ Not yet. At the moment, the only time an exclusive lease is taken out is if a T

## Learn more

- [Worker blog posts](https://octopus.com/blog/tag/workers)
- [Worker blog posts](https://octopus.com/blog/tag/workers/1)
- [Worker pool variables](/docs/projects/variables/worker-pool-variables)
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ Using non-cached versions of these worker-tools can result in long downloads.

## Learn more

- [Worker blog posts](https://octopus.com/blog/tag/workers)
- [Worker blog posts](https://octopus.com/blog/tag/workers/1)
- [Custom docker images](/docs/projects/steps/execution-containers-for-workers/#custom-docker-images)
Loading