Consistent sample API Keys and Octopus URLs.

README.md

@@ -17,6 +17,14 @@ See the [Octopus style guide](https://www.octopus.design/932c0f1a9/p/26f741-writ
 * Sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs)
 * We'll review your PR and accept it or suggest changes
 
+### Default values
+
+When you need to use an example value in docs, please use the below:
+
+- Octopus URL: `https://your-octopus-url`
+- Octopus API key: `API-YOUR-KEY`
+- Snapshot name: `Snapshot XXXXX`
+
 ## Required checks
 
 When you raise a pull request, the following checks will take place:

dictionary-octopus.txt

@@ -1,10 +1,12 @@
-ABCXYZ
 accounttest
+actionid
+actiontemplates
 advfirewall
 ALLUSERSPROFILE
 anglin
 Anglin
 apikey
+apikeys
 APPNAME
 approot
 appsettings
@@ -26,6 +28,7 @@ Bento
 bootstrap
 bootstrapped
 bootstrapper
+bufio
 Ceph
 changeit
 checkservices
@@ -56,12 +59,16 @@ cutover
 dacpac
 Datacenter
 datetime
+dateutil
 deallocate
 deallocated
 dearmor
 decryptable
+defaultpackageversion
 deployers
 deploymentannotation
+deploymentprocess
+deploymentprocesses
 deployto
 DESTKEY
 DIND
@@ -74,16 +81,22 @@ dpkg
 dryrun
 Dspring
 DWORD
+elif
 Elyton
 emptytitle
+environmentids
 expressjs
+externalgroups
+externalusers
 fanout
 Fargate
 feedcred
 Feedz.io
+fieldnames
 fieldset
 Fifield
 figcaption
+filedata
 filestore
 FIPS
 fontawesome
@@ -99,6 +112,8 @@ groff
 Groupsand
 gruntfile
 gulpfile
+hasattr
+Hashtable
 hastscript
 healthcheck
 Helloworld
@@ -111,18 +126,24 @@ HSTS
 HTTPAPI
 hyperthread
 hyperthreading
+icontains
+IGNORECASE
 IMDS
+includesystem
 inetmgr
 inetsrv
 inkey
 INSTALLLOCATION
 internalcustomer
+ioutil
 ipify
+isdir
 Istio
 istioctl
 itemprop
 itemscope
 itemtype
+Itoa
 ITSM
 jjones
 jsondecode
@@ -137,15 +158,19 @@ kustomize
 lastmod
 latestdeployments
 libicu
+libraryvariablesets
 lifecycles
 linecap
 linejoin
 linkerd
 Linq
 Liquibase
+lstrip
 ltsc
+machinepolicies
 maintenanceconfiguration
 majeure
+makedirs
 mattc
 maxage
 mdast
@@ -166,6 +191,7 @@ navigationid
 NETBIOS
 Netscaler
 netsh
+netstandard
 newcert
 newguid
 NEWID
@@ -179,13 +205,17 @@ noopener
 NOPASSWD
 noreferrer
 nosniff
+notcontains
+notlike
 NTLM
 nupkg
 NVARCHAR
+O_WRONLY
 Obtainingthe
 Octo
 octoadmin
 octobak
+Octodiff
 octofxjs
 octoha
 octojs
@@ -210,11 +240,14 @@ oldthumbprint
 oneshot
 onlylogs
 openon
+outfile
+outputformat
 OWASP
 packageversion
 passout
 pemstore
 petclinic
+Petlife
 petshop
 PKCE
 pkcs
@@ -225,8 +258,12 @@ prerenderingchange
 printfn
 Println
 PROGRAMFILES
+projectgroup
+projectgroups
+projecttriggers
 proxied
 proxying
+pscustomobject
 pwsh
 pycryptodome
 querystring
@@ -250,12 +287,19 @@ rolename
 ROOTDIR
 rootelement
 RSASSA
+rstrip
 runbook
+runbookprocesses
+runbookruns
 runbooks
+runbooksnapshot
+runbooksnapshots
+runbooksnapshottemplate
 RUNMANAGERONEXIT
 runtimes
 SAMEORIGIN
 Schannel
+scopeduserroles
 secureclientcertificate
 servedby
 servername
@@ -272,6 +316,7 @@ snapshotting
 sourcedata
 SOURCEKEY
 speculationrules
+Sprintf
 sqlcmd
 SQLEXPRESS
 sqlvolume
@@ -282,6 +327,8 @@ SSRS
 statefulset
 statefulsets
 sthumb
+strconv
+struct
 stylesheet
 subcontext
 sunsetting
@@ -290,8 +337,10 @@ systemprofile
 tabindex
 tabpanel
 tagset
+tagsets
 templateid
 templating
+tenanttag
 tenanttype
 Tentacleinstallation
 Tentacleinstallers
@@ -309,29 +358,37 @@ tsconfigs
 typeof
 umoci
 undeployed
+Unmarshal
 upgradeavailability
 upgradelog
 upgrader
+urllib
 urlset
 useronboarding
+userroles
+utcnow
 variablename
+variableset
 vhdx
 Voltron
 WCAG
 webapps
 WEBDEPLOY
 webfonts
 webserver
+websocket
+websockets
 WEBSVR
 WFLYUT
 Wildfly
 WIXUI
 workerpool
 workerpools
 workertools
+writeheader
+writerow
 xlarge
 xmark
 xvzf
 xxlarge
-YOURAPIKEY
-youtu
+youtu

src/pages/docs/administration/high-availability/configure/auto-scaling-high-availability-nodes.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-06-25
 title: Auto Scaling High Availability Nodes
 description: What to consider if you want to use auto-scaling technology to scale out your Octopus Server High Availability Cluster automatically.
 navOrder: 50
@@ -15,7 +15,7 @@ At this time, we don't recommend auto-scaling if you are using polling tentacles
 
 ## Adding new nodes with Scale-out events
 
-A scale-out event is when auto-scaling technology decides it is time to create a new virtual machine via a schedule or a metric-based trigger.  Octopus High Availablity is designed for new nodes to come online at random intervals.  When you create a new node, an entry is added to the `OctopusServerNodes` table with a default task cap of `5`.  That node will start picking up tasks to process within 60 seconds.  A scale-out event is treated no differently than a person manually creating a VM and configuring as a new node via the UI.
+A scale-out event is when auto-scaling technology decides it is time to create a new virtual machine via a schedule or a metric-based trigger.  Octopus High Availability is designed for new nodes to come online at random intervals.  When you create a new node, an entry is added to the `OctopusServerNodes` table with a default task cap of `5`.  That node will start picking up tasks to process within 60 seconds.  A scale-out event is treated no differently than a person manually creating a VM and configuring as a new node via the UI.
 
 The sections below will walk you through _how_ to automate adding new nodes via a script.
 
@@ -49,11 +49,11 @@ $msiFileName = "Octopus.$versionToDownload-x64.msi"
 $downloadUrl = "https://download.octopusdeploy.com/octopus/$msiFileName"
 $downloadFileName = "$downloadLocation\$msiFileName"
 
-## Bits transfer is much faster than invoke-restmethod or invoke-webrequest for downloading files
+## Bits transfer is much faster than Invoke-RestMethod or Invoke-WebRequest for downloading files
 Write-Output "Downloading $downloadUrl to $outfile"
 Start-BitsTransfer -source $downloadUrl -destination $outfile
 
-$msiExitCode = (Start-Process -FilePath "msiexec.exe" -ArgumentList "/i $downloadFileNam /quiet" -Wait -Passthru).ExitCode 
+$msiExitCode = (Start-Process -FilePath "msiexec.exe" -ArgumentList "/i $downloadFileNam /quiet" -Wait -PassThru).ExitCode 
 Write-Output "Server MSI installer returned exit code $msiExitCode" 
 ```
 
@@ -94,13 +94,13 @@ $masterKey = "YOUR MASTER KEY"
 $databaseServer = "YOUR DATABASE SERVER"
 $databaseName = "YOUR DATABASE NAME"
 $userName = "YOUR DOMAIN SERVICE ACCOUNT USER NAME"
-$password = "YOUR DOMAIN SERVCIE ACCOUNT PASSWORD"
+$password = "YOUR DOMAIN SERVICE ACCOUNT PASSWORD"
 $taskCapSize = "5" ##set this to 0 for UI-only nodes!
 
 ## Add your network mapping script here!
 
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" create-instance --instance "Default" --config "C:\Octopus\OctopusServer.config"
-& "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" database --instance "Default" --masterKey "$masterkey" --connectionString "Data Source=$databaseserver;Initial Catalog=$databaseName;Integrated Security=True;"
+& "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" database --instance "Default" --masterKey "$masterKey" --connectionString "Data Source=$databaseServer;Initial Catalog=$databaseName;Integrated Security=True;"
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" configure --instance "Default" --webForceSSL "False" --webListenPrefixes "http://localhost:80/" --commsListenPort "10943"
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" service --instance "Default" --stop
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" service --instance "Default" --user "$userName" --password "$password"  --install --reconfigure --start
@@ -123,7 +123,7 @@ $taskCapSize = "5" ##set this to 0 for UI-only nodes!
 ## Add your network mapping script here!
 
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" create-instance --instance "Default" --config "C:\Octopus\OctopusServer.config"
-& "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" database --instance "Default" --masterKey "$masterkey" --connectionString "Data Source=$databaseServer;Initial Catalog=$databaseName;Integrated Security=False;User ID=$userName;Password=$password"
+& "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" database --instance "Default" --masterKey "$masterKey" --connectionString "Data Source=$databaseServer;Initial Catalog=$databaseName;Integrated Security=False;User ID=$userName;Password=$password"
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" configure --instance "Default" --webForceSSL "False" --webListenPrefixes "http://localhost:80/" --commsListenPort "10943"
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" service --instance "Default" --stop
 & "C:\Program Files\Octopus Deploy\Octopus\Octopus.Server.exe" service --instance "Default" --user "$userName" --password "$password"  --install --reconfigure --start
@@ -226,8 +226,8 @@ The user required to run this script will need `Administrator` rights to your cl
 :::
 
 ```powershell
-$octopusUrl = "URL of your instances" # e.g. https://samples.octopus.app
-$octopusApiKey = "YOUR API KEY"
+$octopusUrl = "https://your-octopus-url"
+$octopusApiKey = "API-YOUR-KEY"
 $nodeName = "Name of node to delete"
 
 function Write-OctopusVerbose
@@ -303,7 +303,7 @@ function Invoke-OctopusApi
             return Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -Body $body -ContentType 'application/json; charset=utf-8' 
         }
 
-        Write-OctopusVerbose "No data to post or put, calling bog standard invoke-restmethod for $url"
+        Write-OctopusVerbose "No data to post or put, calling bog standard Invoke-RestMethod for $url"
         $result = Invoke-RestMethod -Method $method -Uri $url -Headers @{"X-Octopus-ApiKey" = "$ApiKey" } -ContentType 'application/json; charset=utf-8'
 
         return $result               

src/pages/docs/administration/reporting/report-on-deployments-excel-template.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
+modDate: 2024-06-25
 title: Octopus reporting with an excel template
 description: Octopus reporting with an excel template
 navOrder: 100
@@ -13,7 +13,7 @@ To help you get started, we provide a sample Excel spreadsheet that you can conn
 ![](/docs/administration/reporting/images/3278354.png)
 :::
 
-## Getting started {#Reporting-Gettingstarted}
+## Getting started
 
 The fastest way to get started is to use our Excel spreadsheet template. The spreadsheet uses Pivot Tables and Pivot Charts to summarize the data. You can use it as a starting point, and then modify or adapt it to suit your needs.
 
@@ -41,15 +41,15 @@ To change the source of the data:
 
    ![](/docs/administration/reporting/images/3278360.png)
 
-## Refreshing the data {#Reporting-Refreshingthedata}
+## Refreshing the data
 
 Once you have set up your connection, you can refresh the data from the source whenever you like. If you make your own customizations to the spreadsheet, you can save them, and simply refresh the data in the sheet whenever you like.
 
 :::figure
 ![](/docs/administration/reporting/images/3278361.png)
 :::
 
-## Using the XML feed {#Reporting-UsingtheXMLFeed}
+## Using the XML feed
 
 The best way to consume reporting data from Octopus is using the XML feed. The feed is always available at:
 
@@ -63,7 +63,7 @@ Where:
 For example:
 
 `https://demo.octopus.app/api/reporting/deployments/xml?apikey=API-GUEST`
-`https://your.octopus.app/api/reporting/deployments/xml?apikey=API-1234567891234567891234567`
+`https://your-octopus-url/api/reporting/deployments/xml?apikey=API-1234567891234567891234567`
 
 The XML feed can be consumed programmatically, or via Excel or [Microsoft PowerBI](https://powerbi.microsoft.com/). We have a blog on how to do this using [PowerBI](https://octopus.com/blog/powerbi-report-for-octopus-deploy)