diff --git a/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-web-app/index.md b/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-web-app/index.md index 4b66641715..1a742cdc8b 100644 --- a/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-web-app/index.md +++ b/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-web-app/index.md @@ -91,7 +91,7 @@ The easiest way to achieve this is to use an [execution container](/docs/project If this is not an option in your scenario, we recommend that you provision your own tools on your worker. :::div{.warning} -Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager Powershell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. +Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager PowerShell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. From **Octopus 2021.2**, a warning will also appear in the deployment logs if the Azure tools bundled with Octopus Deploy are used in a step. diff --git a/src/pages/docs/deployments/azure/deploying-to-azure-via-a-firewall/index.md b/src/pages/docs/deployments/azure/deploying-to-azure-via-a-firewall/index.md index 116d5b0854..2fc3a418fa 100644 --- a/src/pages/docs/deployments/azure/deploying-to-azure-via-a-firewall/index.md +++ b/src/pages/docs/deployments/azure/deploying-to-azure-via-a-firewall/index.md @@ -14,7 +14,7 @@ To check you can reach Microsoft cloud through your network, run this script on :::div{.info} -You might need to install Azure Powershell before running this script. For information, see [Install the Azure PowerShell module](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps?view=azps-2.5.0). +You might need to install Azure PowerShell before running this script. For information, see [Install the Azure PowerShell module](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps?view=azps-2.5.0). ::: diff --git a/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-cli.md b/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-cli.md index f1cb68ea90..0634b415c0 100644 --- a/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-cli.md +++ b/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-cli.md @@ -8,7 +8,7 @@ description: A version of Azure CLI is bundled with Octopus Deploy and it's poss --- :::div{.warning} -Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager Powershell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. +Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager PowerShell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. ::: We recommend you configure Octopus Deploy to use your own version of the Azure CLI. diff --git a/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-powershell-modules.md b/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-powershell-modules.md index 6025518c54..b77628a251 100644 --- a/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-powershell-modules.md +++ b/src/pages/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-powershell-modules.md @@ -7,7 +7,7 @@ description: A version of Azure PowerShell is bundled with Octopus Deploy and it --- :::div{.warning} -Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager Powershell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. +Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager PowerShell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. ::: We recommend you configure Octopus Deploy to use your own version of the Azure PowerShell cmdlets. diff --git a/src/pages/docs/deployments/azure/running-azure-powershell/index.md b/src/pages/docs/deployments/azure/running-azure-powershell/index.md index ede1b83397..f17666e9a6 100644 --- a/src/pages/docs/deployments/azure/running-azure-powershell/index.md +++ b/src/pages/docs/deployments/azure/running-azure-powershell/index.md @@ -18,7 +18,7 @@ The easiest way to achieve this is to use an [execution container](/docs/project If this is not an option in your scenario, we recommend that you provision your own tools on your worker. :::div{.warning} -Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager Powershell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. +Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager PowerShell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. From **Octopus 2021.2**, a warning will also appear in the deployment logs if the Azure tools bundled with Octopus Deploy are used in a step. @@ -49,10 +49,10 @@ Learn more about [configuring the right Azure Account](/docs/infrastructure/acco Octopus Cloud uses a special type of worker pool called a [Dynamic Worker Pool](/docs/infrastructure/workers/dynamic-worker-pools). Octopus provides these, and you cannot easily install custom versions of the Azure tools on them. -To use your own version of the Azure CLI or Azure Powershell cmdlets when using Dynamic Worker Pools, please do the following: +To use your own version of the Azure CLI or Azure PowerShell cmdlets when using Dynamic Worker Pools, please do the following: - Configure your step to use a Dynamic Worker pool that supports [execution containers](/docs/projects/steps/execution-containers-for-workers). -- Configure your step to run in an execution container with a [compatible docker image](/docs/projects/steps/execution-containers-for-workers/#which-image) that contains the versions of the Azure CLI or Azure Powershell cmdlets that you would like to use. +- Configure your step to run in an execution container with a [compatible docker image](/docs/projects/steps/execution-containers-for-workers/#which-image) that contains the versions of the Azure CLI or Azure PowerShell cmdlets that you would like to use. ## Run an Azure PowerShell script step diff --git a/src/pages/docs/deployments/custom-scripts/aws-cli-scripts.md b/src/pages/docs/deployments/custom-scripts/aws-cli-scripts.md index 82b7f7c85e..ebbd05fbae 100644 --- a/src/pages/docs/deployments/custom-scripts/aws-cli-scripts.md +++ b/src/pages/docs/deployments/custom-scripts/aws-cli-scripts.md @@ -84,7 +84,7 @@ Write-Host "Get caller identity with the AWS CLI" Write-Host "aws sts get-caller-identity" aws sts get-caller-identity -Write-Host "Get the version of the Powershell module" +Write-Host "Get the version of the PowerShell module" Write-Host "Get-AWSPowerShellVersion" Get-AWSPowerShellVersion @@ -123,10 +123,10 @@ The third option is to run a script from a package. This is done by selecting th Octopus Cloud uses a special type of worker pool called a [Dynamic Worker Pool](/docs/infrastructure/workers/dynamic-worker-pools). Octopus provides these, and you cannot easily install custom versions of the AWS tools on them. -To use your own version of the AWS CLI or AWS Powershell cmdlets when using Dynamic Worker Pools, please do the following: +To use your own version of the AWS CLI or AWS PowerShell cmdlets when using Dynamic Worker Pools, please do the following: - Configure your step to use a Dynamic Worker pool that supports [execution containers](/docs/projects/steps/execution-containers-for-workers). -- Configure your step to run in an execution container with a [compatible docker image](/docs/projects/steps/execution-containers-for-workers/#which-image) that contains the versions of the AWS CLI or AWS Powershell cmdlets that you would like to use. +- Configure your step to run in an execution container with a [compatible docker image](/docs/projects/steps/execution-containers-for-workers/#which-image) that contains the versions of the AWS CLI or AWS PowerShell cmdlets that you would like to use. ## Older versions diff --git a/src/pages/docs/deployments/custom-scripts/azure-powershell-scripts.md b/src/pages/docs/deployments/custom-scripts/azure-powershell-scripts.md index f95e53de74..8409327179 100644 --- a/src/pages/docs/deployments/custom-scripts/azure-powershell-scripts.md +++ b/src/pages/docs/deployments/custom-scripts/azure-powershell-scripts.md @@ -21,7 +21,7 @@ The easiest way to achieve this is to use an [execution container](/docs/project If this is not an option in your scenario, we recommend that you provision your own tools on your worker. :::div{.warning} -Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager Powershell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. +Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager PowerShell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. We recommend you configure Octopus Deploy to use your own [version of the Azure PowerShell cmdlets](/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-powershell-modules/) and [version of the Azure CLI](/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-cli). ::: @@ -45,10 +45,10 @@ Learn more about [configuring the right Azure Account](/docs/infrastructure/acco Octopus Cloud uses a special type of worker pool called a [Dynamic Worker Pool](/docs/infrastructure/workers/dynamic-worker-pools). Octopus provides these, and you cannot easily install custom versions of the Azure tools on them. -To use your own version of the Azure CLI or Azure Powershell cmdlets when using Dynamic Worker Pools, please do the following: +To use your own version of the Azure CLI or Azure PowerShell cmdlets when using Dynamic Worker Pools, please do the following: - Configure your step to use a Dynamic Worker pool that supports [execution containers](/docs/projects/steps/execution-containers-for-workers). -- Configure your step to run in an execution container with a [compatible docker image](/docs/projects/steps/execution-containers-for-workers/#which-image) that contains the versions of the Azure CLI or Azure Powershell cmdlets that you would like to use. +- Configure your step to run in an execution container with a [compatible docker image](/docs/projects/steps/execution-containers-for-workers/#which-image) that contains the versions of the Azure CLI or Azure PowerShell cmdlets that you would like to use. These scripts are executed on the Octopus Server and will be pre-authenticated using the selected Azure Account. For information about adding a step to the deployment process, see the [add step](/docs/projects/steps) section. diff --git a/src/pages/docs/deployments/custom-scripts/debugging-powershell-scripts/index.md b/src/pages/docs/deployments/custom-scripts/debugging-powershell-scripts/index.md index 952d981d3c..6009e39942 100644 --- a/src/pages/docs/deployments/custom-scripts/debugging-powershell-scripts/index.md +++ b/src/pages/docs/deployments/custom-scripts/debugging-powershell-scripts/index.md @@ -30,7 +30,7 @@ When the Tentacle executes the script, it will print out instructions on how to ``` ... -The Powershell execution engine is waiting for a PowerShell script debugger to attach. +The PowerShell execution engine is waiting for a PowerShell script debugger to attach. Use the following commands to begin debugging this script: Enter-PSSession -ComputerName Server01 -Credential Enter-PSHostProcess -Id 2284 diff --git a/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md b/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md index 9f2bbd476d..8b12be009a 100644 --- a/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md +++ b/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md @@ -82,8 +82,8 @@ If you are deploying the same package to multiple platforms, you can: The platform-specific priority order Octopus uses to select scripts is: -- Linux: Bash, Python, C#, F#, Powershell -- Windows: Powershell, Python, C#, F#, Bash +- Linux: Bash, Python, C#, F#, PowerShell +- Windows: PowerShell, Python, C#, F#, Bash Example: You are deploying an application to both Windows and Linux. You can write a single `PreDeploy.py` python script, making sure the python runtime is installed on both platforms. Alternatively, you can write both `PreDeploy.sh` and `PreDeploy.ps1`, and Octopus will run the Bash script on Linux and the PowerShell script on Windows. diff --git a/src/pages/docs/deprecations/index.md b/src/pages/docs/deprecations/index.md index 9e1343b5d3..d7cacc7e42 100644 --- a/src/pages/docs/deprecations/index.md +++ b/src/pages/docs/deprecations/index.md @@ -71,13 +71,13 @@ As of `2024.4` the usage of ScriptCS is being deprecated in Octopus. This has be ## Deprecations for 2024.3 -### Azure Resource Manager Powershell Module +### Azure Resource Manager PowerShell Module -The AzureRM Powershell modules were Microsoft's way of integrating Powershell with Azure resources. Microsoft has deprecated AzureRM in favor of the Azure CLI or the Az Powershell modules. +The AzureRM PowerShell modules were Microsoft's way of integrating PowerShell with Azure resources. Microsoft has deprecated AzureRM in favor of the Azure CLI or the Az PowerShell modules. AzureRM was [deprecated by Microsoft](https://learn.microsoft.com/en-us/powershell/azure/azurerm-retirement-overview) as of February 29, 2024. -AzureRm will remain available until July 2024 (with an in-app warning). After this, you'll need to move to either `az cli` or the `az module for powershell` +AzureRm will remain available until July 2024 (with an in-app warning). After this, you'll need to move to either `az cli` or the `az module for PowerShell` for Azure authentication. ## Deprecations for 2024.2 @@ -126,7 +126,7 @@ Further details on the background for this update are available on the [Dropping ### F# Script Steps -Due to the low uptake of F# script steps and the work required to upgrade them for continued use in our modern codebase, we will no longer support F# script steps from `2024.1`. Customers who continue to need F# scripts in later Octopus versions should use standard shell scripting (powershell or bash) and invoke their scripts via their own F# tools included in additional [referenced packages](https://octopus.com/docs/deployments/custom-scripts/run-a-script-step#referencing-packages). +Due to the low uptake of F# script steps and the work required to upgrade them for continued use in our modern codebase, we will no longer support F# script steps from `2024.1`. Customers who continue to need F# scripts in later Octopus versions should use standard shell scripting (PowerShell or bash) and invoke their scripts via their own F# tools included in additional [referenced packages](https://octopus.com/docs/deployments/custom-scripts/run-a-script-step#referencing-packages). ## Deprecations for 2023.3 diff --git a/src/pages/docs/infrastructure/accounts/azure/index.md b/src/pages/docs/infrastructure/accounts/azure/index.md index 5b0f411c95..5fe3f460bf 100644 --- a/src/pages/docs/infrastructure/accounts/azure/index.md +++ b/src/pages/docs/infrastructure/accounts/azure/index.md @@ -694,7 +694,7 @@ Write-OctopusVerbose " 1) In Azure: create an Azure Service Principal and ass Write-OctopusVerbose " 2) In Octopus Deploy: create an Azure Account using the credentials created in step 1" Write-OctopusVerbose "For this to work you will need to have the following installed. If it is not installed, then this script will it install it for you from the PowerShell Gallery." -Write-OctopusVerbose " 1) Azure Az Powershell Modules" +Write-OctopusVerbose " 1) Azure Az PowerShell Modules" $answer = Read-Host -Prompt "Do you wish to continue? y/n" if ($answer.ToLower() -ne "y") diff --git a/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc.md b/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc.md index 9569022826..4ec790ebb5 100644 --- a/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc.md +++ b/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc.md @@ -499,7 +499,7 @@ az deployment group create \ ## Troubleshooting -To troubleshoot the installation, you can use [`Start-Transcript`](https://docs.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.1) to write the Powershell session to a file. +To troubleshoot the installation, you can use [`Start-Transcript`](https://docs.microsoft.com/powershell/module/microsoft.powershell.host/start-transcript?view=powershell-7.1) to write the PowerShell session to a file. If you have remote access to the machine you are troubleshooting the installation for, these two commands may offer diagnostic information about the state of DSC: diff --git a/src/pages/docs/infrastructure/workers/dynamic-worker-pools.md b/src/pages/docs/infrastructure/workers/dynamic-worker-pools.md index fee400e0d9..23152d0828 100644 --- a/src/pages/docs/infrastructure/workers/dynamic-worker-pools.md +++ b/src/pages/docs/infrastructure/workers/dynamic-worker-pools.md @@ -89,7 +89,7 @@ Each `Ubuntu Server 22.04` worker is provisioned with a baseline of tools includ - .NET 6 - Docker (latest) -- Powershell Core (latest) +- PowerShell Core (latest) - Python 3 (latest) - GCloud CLI (367.0.0) @@ -117,7 +117,7 @@ Each `Windows Server Core 2022` worker is provisioned with a baseline of tools i - Nuget CLI (latest) - Octopus Client (latest) - Pip (latest) -- Powershell Core (latest) +- PowerShell Core (latest) - Python (3.7.4) - GCloud CLI (339.0.0) diff --git a/src/pages/docs/kubernetes/steps/helm.md b/src/pages/docs/kubernetes/steps/helm.md index 71485dc836..47af04624e 100644 --- a/src/pages/docs/kubernetes/steps/helm.md +++ b/src/pages/docs/kubernetes/steps/helm.md @@ -110,7 +110,7 @@ Helm performs some strict version checks when performing any commands against th Like the other Kubernetes steps, the Octopus Server or workers will run the Helm commands directly during execution and need to have the `helm` executable installed. ::: -Since it is quite common to have different versions of Helm across your deployment workers or even across different environments clusters, this option lets you override the helm client tool that is invoked. By default, Octopus will expect the helm command to be directly available to the execution context. Provide either the explicit full path to the desired version of the helm tool or include a version of helm as a package. The available version can be downloaded via the helm public [GitHub repository](https://github.com/helm/helm/releases). Unlike some other Octopus steps like [Azure Powershell Scripts](/docs/deployments/custom-scripts/azure-powershell-scripts), the helm client tools are not automatically embedded or installed by Octopus. This is due to the strict version requirements that would differ between Octopus Server installations, and the diverse number of different platform builds available. +Since it is quite common to have different versions of Helm across your deployment workers or even across different environments clusters, this option lets you override the helm client tool that is invoked. By default, Octopus will expect the helm command to be directly available to the execution context. Provide either the explicit full path to the desired version of the helm tool or include a version of helm as a package. The available version can be downloaded via the helm public [GitHub repository](https://github.com/helm/helm/releases). Unlike some other Octopus steps like [Azure PowerShell Scripts](/docs/deployments/custom-scripts/azure-powershell-scripts), the helm client tools are not automatically embedded or installed by Octopus. This is due to the strict version requirements that would differ between Octopus Server installations, and the diverse number of different platform builds available. ### Template values diff --git a/src/pages/docs/kubernetes/targets/kubernetes-agent/storage.md b/src/pages/docs/kubernetes/targets/kubernetes-agent/storage.md index 2c39d112dd..ca9385cb83 100644 --- a/src/pages/docs/kubernetes/targets/kubernetes-agent/storage.md +++ b/src/pages/docs/kubernetes/targets/kubernetes-agent/storage.md @@ -13,7 +13,7 @@ The following is applicable to both Kubernetes Agent and Kubernetes Worker. During a deployment, Octopus Server first sends any required scripts and packages to [Tentacle](https://octopus.com/docs/infrastructure/deployment-targets/tentacle) which writes them to the file system. The actual script execution then takes place in a different process called [Calamari](https://github.com/OctopusDeploy/Calamari), which retrieves the scripts and packages directly from the file system. -On a Kubernetes agent (or worker), scripts are executed in separate Kubernetes pods (script pod) as opposed to in a local shell (Bash/Powershell). This means the Tentacle pod and script pods don’t automatically share a common file system. +On a Kubernetes agent (or worker), scripts are executed in separate Kubernetes pods (script pod) as opposed to in a local shell (Bash/PowerShell). This means the Tentacle pod and script pods don’t automatically share a common file system. Since the Kubernetes agent/worker is built on the Tentacle codebase, it is necessary to configure shared storage so that the Tentacle Pod can write the files in a place that the script pods can read from. diff --git a/src/pages/docs/octopus-rest-api/octopus-cli/index.mdx b/src/pages/docs/octopus-rest-api/octopus-cli/index.mdx index 0d7b407fe3..04963ae276 100644 --- a/src/pages/docs/octopus-rest-api/octopus-cli/index.mdx +++ b/src/pages/docs/octopus-rest-api/octopus-cli/index.mdx @@ -47,7 +47,7 @@ The Octo CLI, which leans heavily on the [Octopus Clients library](https://githu - **[dump-deployments](/docs/octopus-rest-api/octopus-cli/dump-deployments)**: Writes deployments to an XML file that can be imported in Excel. - **[export](/docs/octopus-rest-api/octopus-cli/export)**: Exports an object to a JSON file. Deprecated. Please see [https://g.octopushq.com/DataMigration](https://g.octopushq.com/DataMigration) for alternative options. - **[import](/docs/octopus-rest-api/octopus-cli/import)**: Imports an Octopus object from an export file. Deprecated. Please see [https://g.octopushq.com/DataMigration](https://g.octopushq.com/DataMigration) for alternative options. -- **[install-autocomplete](/docs/octopus-rest-api/octopus-cli/install-autocomplete)**: Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & powershell. +- **[install-autocomplete](/docs/octopus-rest-api/octopus-cli/install-autocomplete)**: Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & PowerShell. - **[list-deployments](/docs/octopus-rest-api/octopus-cli/list-deployments)**: Lists a number of deployments by project, environment or by tenant. - **[list-environments](/docs/octopus-rest-api/octopus-cli/list-environments)**: Lists environments. - **[list-latestdeployments](/docs/octopus-rest-api/octopus-cli/list-latestdeployments)**: Lists the releases last-deployed in each environment. diff --git a/src/pages/docs/octopus-rest-api/octopus-cli/install-autocomplete.mdx b/src/pages/docs/octopus-rest-api/octopus-cli/install-autocomplete.mdx index 0c0a356daa..66a68650a7 100644 --- a/src/pages/docs/octopus-rest-api/octopus-cli/install-autocomplete.mdx +++ b/src/pages/docs/octopus-rest-api/octopus-cli/install-autocomplete.mdx @@ -3,7 +3,7 @@ layout: src/layouts/Default.astro pubDate: 2023-01-01 modDate: 2023-01-01 title: Install autocomplete -description: Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & powershell. +description: Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & PowerShell. navOrder: 100 --- import OctoAutocompleteTabCompletion from 'src/shared-content/octopus-cli/octo-autocomplete-tab-completion.include.md'; @@ -13,7 +13,7 @@ Install a shell auto-complete script into your shell profile, if they aren't alr **install-autocomplete options** ``` -Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & powershell. +Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & PowerShell. Usage: octo install-autocomplete [] @@ -24,7 +24,7 @@ Install AutoComplete: --shell=VALUE The type of shell to install auto-complete scripts for. This will alter your shell configuration files. Supported shells are Bash, - Powershell, Pwsh and Zsh. + PowerShell, Pwsh and Zsh. --dryRun [Optional] Dry run will output the proposed changes to console, instead of writing to disk. diff --git a/src/pages/docs/projects/steps/execution-containers-for-workers/index.mdx b/src/pages/docs/projects/steps/execution-containers-for-workers/index.mdx index 0a820f0f60..111ef4b5fa 100644 --- a/src/pages/docs/projects/steps/execution-containers-for-workers/index.mdx +++ b/src/pages/docs/projects/steps/execution-containers-for-workers/index.mdx @@ -154,7 +154,7 @@ RUN apt-get update && \ apt-get clean && \ rm -rf /var/lib/apt/lists/* -# Powershell core +# PowerShell Core # https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-7.1#ubuntu-2004 RUN curl -LO -k "https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb" && \ dpkg -i packages-microsoft-prod.deb && \ diff --git a/src/pages/docs/projects/variables/system-variables.md b/src/pages/docs/projects/variables/system-variables.md index b0f528a2a4..f23aad62b4 100644 --- a/src/pages/docs/projects/variables/system-variables.md +++ b/src/pages/docs/projects/variables/system-variables.md @@ -1493,7 +1493,7 @@ Example: True `Octopus.Action.PowerShell.CustomPowerShellVersion` -If specified, Windows PowerShell scripts will be invoked using `PowerShell.exe -version {Version}` where {Version} is the value you specified. Accepted values are *2.0*, *3.0*, *4.0, 5.0*.
PowerShell Core scripts will be invoked using the installed version of PowerShell core which matches the specified value. The value must match one of the directories contained within `%PROGRAMFILES%\PowerShell`. Example values include *6* and *7-preview*. +If specified, Windows PowerShell scripts will be invoked using `PowerShell.exe -version {Version}` where {Version} is the value you specified. Accepted values are *2.0*, *3.0*, *4.0, 5.0*.
PowerShell Core scripts will be invoked using the installed version of PowerShell Core which matches the specified value. The value must match one of the directories contained within `%PROGRAMFILES%\PowerShell`. Example values include *6* and *7-preview*. Example: 2.0 diff --git a/src/pages/docs/runbooks/runbook-examples/gcp/create-nlb.md b/src/pages/docs/runbooks/runbook-examples/gcp/create-nlb.md index bae8340ed5..67da5c5f47 100644 --- a/src/pages/docs/runbooks/runbook-examples/gcp/create-nlb.md +++ b/src/pages/docs/runbooks/runbook-examples/gcp/create-nlb.md @@ -41,7 +41,7 @@ The next sections explains how to configure a service account to be authorized t #### Create project variables {#gcp-project-variables} -We'll use project [variables](/docs/projects/variables/) to authorize the gcloud CLI with Google Cloud with the help of a Powershell function included in a [Script module](/docs/deployments/custom-scripts/script-modules). +We'll use project [variables](/docs/projects/variables/) to authorize the gcloud CLI with Google Cloud with the help of a PowerShell function included in a [Script module](/docs/deployments/custom-scripts/script-modules). Create two [sensitive variables](/docs/projects/variables/sensitive-variables), one for the service account email, and the other will contain the service account key. This is a JSON payload you obtain when creating the service account in Google Cloud: diff --git a/src/shared-content/scripts/run-healthcheck-scripts.include.md b/src/shared-content/scripts/run-healthcheck-scripts.include.md index a46414c81e..4077f72c16 100644 --- a/src/shared-content/scripts/run-healthcheck-scripts.include.md +++ b/src/shared-content/scripts/run-healthcheck-scripts.include.md @@ -9,7 +9,7 @@ $octopusURL = "https://your-octopus-url" $octopusAPIKey = "API-YOUR-KEY" $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } $spaceName = "Default" -$Description = "Health check started from Powershell script" +$Description = "Health check started from PowerShell script" $TimeOutAfterMinutes = 5 $MachineTimeoutAfterMinutes = 5 @@ -63,7 +63,7 @@ Add-Type -Path "path\to\Octopus.Client.dll" $octopusURL = "https://your-octopus-url" $octopusAPIKey = "API-YOUR-KEY" $spaceName = "Default" -$Description = "Health check started from Powershell script" +$Description = "Health check started from PowerShell script" $TimeOutAfterMinutes = 5 $MachineTimeoutAfterMinutes = 5 diff --git a/src/shared-content/tentacle/configure-k8s-worker.include.md b/src/shared-content/tentacle/configure-k8s-worker.include.md index 7c0634a84c..699429f2a2 100644 --- a/src/shared-content/tentacle/configure-k8s-worker.include.md +++ b/src/shared-content/tentacle/configure-k8s-worker.include.md @@ -15,10 +15,10 @@ kubectl config view 3. Enter a **Name** for the worker, and select the **Worker Pools** to which the worker should belong, and select **NEXT** 1. The dialog permits for the inline creation of a worker pool via the **+** button. 2. Click **Show advanced** to provide a custom Storage class or override the Octopus Server URL if required -4. Select the desired shell (bash or powershell) and copy and the supplied command +4. Select the desired shell (bash or PowerShell) and copy and the supplied command 5. Execute the copied command in a terminal configured with your k8s cluster, and click **NEXT** 1. This step is not required if the NFS driver already exists in your cluster (due to prior installs of k8s worker or deployment target) -5. Select the desired shell (bash or powershell), then copy the supplied command +5. Select the desired shell (bash or PowerShell), then copy the supplied command 6. Execute the copied command in a terminal configured with your k8s cluster. 1. Installing the Helm chart will take some time (potentially minutes depending on infrastructure). 6. A green 'success' bar will appear when the Helm Chart has completed installation, and the worker has registered with the Octopus Server.