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.

Sign up for GitHub

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

CoTerm: Mention Homebrew install method and explorer page #28166

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

CoTerm: Mention Homebrew install method and explorer page #28166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4f726a
Mention Homebrew install method
rgwood-dd Mar 14, 2025
02c239a
Link to CoTerm explorer page
rgwood-dd Mar 14, 2025
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
12 changes: 7 additions & 5 deletions content/en/coterm/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ further_reading:
text: "CoTerm Configuration Rules"
---

1. Install Datadog CoTerm by running:
CoTerm is currently supported on macOS and Linux.

1. Install Datadog CoTerm by running `brew install coterm` (macOS only), or:

```shell
curl --tlsv1.2 --proto '=https' -sSf 'https://coterm.datadoghq.com/install-ddcoterm.sh' | bash
```

This command downloads the latest version of CoTerm to `.ddcoterm/bin/ddcoterm` and updates your PATH in `.bashrc` and `.zshrc`. Restart your terminal or source your profile. If you are using a shell other than Bash or Zsh, add `path/to/.ddcoterm/bin` to your PATH manually.
This command downloads the latest version of CoTerm to `.ddcoterm/bin/ddcoterm` and updates your PATH in `.bashrc` and `.zshrc`. Restart your terminal or source your profile. If you are using a shell other than Bash or Zsh, add `path/to/.ddcoterm/bin` to your PATH manually.

2. If your [Datadog site][6] is not `https://app.datadoghq.com`, set your site in `.ddcoterm/config.yaml` under `connection_config.host`:
```yaml
Expand All @@ -27,7 +29,7 @@ further_reading:
host: {{< region-param key=dd_full_site code="true" >}}
...
```

3. Initialize your configuration file by running:

```shell
Expand Down Expand Up @@ -59,7 +61,7 @@ The `~/.ddcoterm/config.yaml` file contains your CoTerm configurations:
: Enable or disable experimental `ptrace`-based process monitoring on Linux. Defaults to `false`.

`connection_config`
:
:
`host`
: Host for connecting to Datadog. Defaults to `https://app.datadoghq.com`.

Expand Down Expand Up @@ -90,4 +92,4 @@ To uninstall CoTerm, delete the `.ddcoterm` folder.
[3]: /coterm/usage
[4]: /coterm/rules
[5]: /coterm/usage/#require-approval-for-commands
[6]: /getting_started/site/
[6]: /getting_started/site/
12 changes: 8 additions & 4 deletions content/en/coterm/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ further_reading:
text: "CoTerm Configuration Rules"
---

## View all recorded terminal sessions

Recordings are listed [here](https://app.datadoghq.com/terminal-streams) in the Datadog UI.

## CoTerm CLI command structure

```shell
Expand All @@ -24,7 +28,7 @@ Run `ddcoterm --help` for all options and commands.

CoTerm records terminal sessions that you can play back and review in Datadog. For your security, sensitive data (such as passwords and API keys) are [automatically redacted][1]. Any processes launched in the terminal session are recorded as [events][2].

### Launch a recorded terminal session
### Launch and record an interactive terminal session
To manually launch Datadog CoTerm and record the entirety of your terminal session:

```shell
Expand Down Expand Up @@ -75,7 +79,7 @@ process_config:
end
{{< /code-block >}}

With this configuration, CoTerm intercepts any `kubectl scale` command without a `--context` flag.
With this configuration, CoTerm intercepts any `kubectl scale` command without a `--context` flag.

{{< img src="coterm/linter-warning.png" alt="Command line interface. The user has run 'kubectl scale foo'. The output says 'Warning from CoTerm: No kubectl context specified (effective context: 'minikube'). It is recommended to always explicitly specify the context when running kubectl scale. Do you want to continue? (y/n)'" style="width:70%;" >}}

Expand Down Expand Up @@ -108,7 +112,7 @@ With this configuration, when you run a `kubectl scale --context prod` command,
To create an approval request manually, run:

```shell
ddcoterm approve
ddcoterm approve
```

#### Bypass approval
Expand All @@ -130,4 +134,4 @@ COTERM_BREAK_GLASS=true kubectl delete foo
[3]: /service_management/case_management/
[4]: /coterm/rules
[5]: /service_management/incident_management/
[6]: /coterm/install
[6]: /coterm/install
Loading