Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge main into docbot branch #2055

Merged
merged 18 commits into from
Oct 25, 2023
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ For example, if you added `MySQL` to an article and it was flagged as an unknown

Some consideration should be given as to whether it should be `MySQL` or `MySql` and just a single entry should be added to `dictionary-octopus.txt` to promote consistency.

### Exclusions

You can see files excluded from the spell check in `cspell.json`.

## Deploying to preview environment (Octopus Developers)

Before merging to `main` it's possible you'd like to see your changes in a preview environment. It's simple to do this:
Expand Down
1 change: 1 addition & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"package.json",
"package-lock.yaml",
"pnpm-lock.yaml",
"docs/credits.md",
"node_modules/**"
]
}
43 changes: 41 additions & 2 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
apikey
astro
runbook
Runbook
deallocate
deallocated
DONTVALIDATEPATH
Fargate
FIPS
HKEY
HKLM
hotfix
hotfixes
HSTS
ITSM
lifecycles
maxage
msiexec
MTTR
nologs
NTLM
Octo
octobak
Octopub
octopusid
octopuslabs
OIDC
onlylogs
reprioritize
reprovisioned
reprovisioning
Runbook
runbook
runbooks
Schannel
sthumb
swaggerui
systemprofile
Trivy
upgradelog
WIXUI
workertools
xmark
kustomize
Octostache
kustomization
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"img": "node --no-experimental-fetch ./src/themes/accelerator/utilities/img.mjs",
"dev": "node --no-experimental-fetch ./src/themes/accelerator/utilities/img.mjs && astro dev",
"test": "astro build && npx playwright install --with-deps && npx playwright test",
"spellcheck": "git fetch origin main:refs/remotes/origin/main && git diff origin/main --name-only | cspell --file-list stdin",
"spellcheck": "git fetch origin main:refs/remotes/origin/main && git diff origin/main --name-only --diff-filter=ACMRTUXB | cspell --file-list stdin",
"build": "astro build",
"preview": "astro preview",
"astro": "astro",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/pages/docs/administration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Administration
navTitle: Overview
navSection: Administration
description: Octopus administration tasks and command reference.
navOrder: 120
navOrder: 140
hideInThisSectionHeader: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ navOrder: 2300

In some environment the Windows Services for Octopus Server and Tentacle may not reliably start when the server is rebooted. This typically occurs during a restart after Windows Updates have been installed.

## Why does it happen? {#ServiceWatchdog-Whydoesithappen?}
## Why does it happen? {#ServiceWatchdog-WhyDoesItHappen?}

The exact cause of this issue has not yet been determined, however investigation indicates that it may be related to a delay caused by slow initialization of the .NET CLR during these restarts.

## What can you do about it? {#ServiceWatchdog-Whatcanyoudoaboutit?}
## What can you do about it? {#ServiceWatchdog-WhatCanYouDoAboutIt?}

The **watchdog** command can be used on the command line to configure a Windows Scheduled Task that ensures the services are running. The command is used as follows.

### Configure the watchdog {#ServiceWatchdog-ConfiguringtheWatchdog}
### Configure the watchdog {#ServiceWatchdog-ConfiguringTheWatchdog}

```powershell
Tentacle.exe watchdog --create --instances * --interval 10
Expand All @@ -41,7 +41,7 @@ Tentacle.exe watchdog --create --instances Tentacle --interval 10
```
:::

### Cancel the watchdog {#ServiceWatchdog-CancelingtheWatchdog}
### Cancel the watchdog {#ServiceWatchdog-CancelingTheWatchdog}

```powershell
Tentacle.exe watchdog --delete
Expand All @@ -55,7 +55,7 @@ If you have scheduled the watchdog to monitor all instances on a server but you
:::

###
Recreating the Watchdog {#ServiceWatchdog-RecreatingtheWatchdog}
Recreating the Watchdog {#ServiceWatchdog-RecreatingTheWatchdog}

As mentioned above, running create again can be used to change the instances and interval for the watchdog, but all other settings will remain unchanged. If you do want to reset all of the other settings you can easily combine the delete and create, for example

Expand All @@ -73,7 +73,7 @@ The default log file location is therefore **C:\Windows\System32\config\systempr

This is only for information related to which instances the watchdog attempted to start, and any errors it received while trying to start the windows services. Any instance specific errors will still be located in the instance's log file.

### Tentacle vs Octopus Server {#ServiceWatchdog-TentaclevsOctopusServer}
### Tentacle vs Octopus Server {#ServiceWatchdog-TentacleVsOctopusServer}

The above commands work equally for Octopus Server and Tentacle (by using **Octopus.Server.exe** instead of **Tentacle.exe**). Noting that the Tentacle Watchdog will only check Tentacle instances and the Octopus Server Watchdog will only check server instances. They can both be configured simultaneously on the same machine.

Expand All @@ -85,7 +85,7 @@ Octopus.Server.exe watchdog --create --instances OctopusServer --interval 10
```
:::

## Installation locations {#ServiceWatchdog-Installationlocations}
## Installation locations {#ServiceWatchdog-InstallationLocations}

Please note that the task created by the watchdog references the Octopus Server/Tentacle executable from the location it was in when the watchdog command was executed.

Expand Down
Loading
Loading