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

Add kubectl datadog plugin doc #82

Merged
merged 4 commits into from
May 7, 2020
Merged
Show file tree
Hide file tree
Changes from 2 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 docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ datadog-agent-lkfqt 0/1 Running 0 15s
datadog-agent-zvdbw 1/1 Running 0 8m1s
```

## Install the kubectl plugin

[kubctl plugin doc](/docs/kubectl-plugin.md)

## Cleanup

The following command deletes all the Kubernetes resources created by the Datadog Operator and the linked `DatadogAgent` `datadog`.
Expand Down
64 changes: 64 additions & 0 deletions docs/kubectl-plugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Datadog Operator kubectl plugin

## Install the plugin with krew

The Datatadog Operator comes with a kubectl plugin providing a set of helper utilities giving visibility into certain internal components which some users may find useful.
clamoriniere marked this conversation as resolved.
Show resolved Hide resolved

To install please use the [krew plugin manager](https://krew.sigs.k8s.io/)
clamoriniere marked this conversation as resolved.
Show resolved Hide resolved

The krew plugin manifest url can be found on the project [release page](https://github.com/DataDog/datadog-operator/releases). Each release has its own `datadog-plugin.yaml` manifest file.

```console
$ kubectl krew install --manifest-url https://github.com/DataDog/datadog-operator/releases/download/<release-version>/datadog-plugin.yaml
Installing plugin: datadog
Installed plugin: datadog
\
| Use this plugin:
| kubectl datadog
| Documentation:
| https://github.com/DataDog/datadog-operator
/
```

## Available commands

```console
$ kubectl datadog --help
Usage:
datadog [command]

Available Commands:
agent
clusteragent
flare Collect a Datadog's Operator flare and send it to Datadog
get Get DatadogAgent deployment(s)
help Help about any command
validate

```

### Agent sub-commands

```console
$ kubectl datadog agent --help
Usage:
datadog agent [command]

Available Commands:
check Find check errors
find Find datadog agent pod monitoring a given pod
upgrade Upgrade the Datadog Agent version

```

### Cluster Agent sub-commands

```console
$ kubectl datadog clusteragent --help
Usage:
datadog clusteragent [command]

Available Commands:
leader Get Datadog Cluster Agent leader
upgrade Upgrade the Datadog Cluster Agent version
```
clamoriniere marked this conversation as resolved.
Show resolved Hide resolved