Skip to content

Commit

Permalink
Update install instructions (DataDog#792)
Browse files Browse the repository at this point in the history 
* Update install instructions

Co-authored-by: Christine Chen <ChristineTChen@users.noreply.github.com>
Co-authored-by: Pierre Guceski <pierre.guceski@datadoghq.com>
  • Loading branch information
@hithwen @ChristineTChen @eliadeini
3 people authored and eliadeini committed Jun 1, 2021
1 parent 7bb55f8 commit 00dca3b
Show file tree
Hide file tree
Showing 36 changed files with 742 additions and 1,209 deletions.
70 changes: 24 additions & 46 deletions aqua/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,41 +13,21 @@ need to install it yourself.

### Installation

If you are using Agent v6.8+ follow the instructions below to install the Aqua check on your host. See our dedicated Agent guide for [installing community integrations][3] to install checks with the [Agent prior to version 6.8][4] or the [Docker Agent][5]:
If you are using Agent v6.8+ follow the instructions below to install the Aqua check on your host. See the dedicated Agent guide for [installing community integrations][3] to install checks with the [Agent prior to version 6.8][4] or the [Docker Agent][5]:

1. Install the [developer toolkit][6].
2. Clone the integrations-extras repository:
1. [Download and launch the Datadog Agent][2].
2. Run the following command to install the integrations wheel with the Agent:

```shell
git clone https://github.com/DataDog/integrations-extras.git.
datadog-agent integration install -t datadog-aqua==<INTEGRATION_VERSION>
```

3. Update your `ddev` config with the `integrations-extras/` path:

```shell
ddev config set extras ./integrations-extras
```

4. To build the `aqua` package, run:

```shell
ddev -e release build aqua
```

5. [Download and launch the Datadog Agent][7].
6. Run the following command to install the integrations wheel with the Agent:

```shell
datadog-agent integration install -w <PATH_OF_AQUA_ARTIFACT>/<AQUA_ARTIFACT_NAME>.whl
```

7. Configure your integration like [any other packaged integration][8].
3. Configure your integration like [any other packaged integration][6].

### Configuration

#### Metric Collection

1. Edit the `aqua.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][9] to start collecting your Aqua [metrics](#metrics). See the [sample conf.yaml][10] for all available configuration options.:
1. Edit the `aqua.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][7] to start collecting your Aqua [metrics](#metrics). See the [sample conf.yaml][8] for all available configuration options.:

```yaml
instances:
Expand All @@ -58,7 +38,7 @@ If you are using Agent v6.8+ follow the instructions below to install the Aqua c
Change the `api_user` and `password` parameter values and configure them for your environment.

2. [Restart the Agent][11].
2. [Restart the Agent][9].

#### Log Collection

Expand All @@ -74,12 +54,12 @@ To collect Aqua audit logs:
3. Activate the Webhook integration
4. Enable it and add the following endpoint: `https://http-intake.logs.datadoghq.com/v1/input/<DATADOG_API_KEY>?ddsource=aqua`

- Replace `<DATADOG_API_KEY>` by your [Datadog Api Key][12].
- Replace `<DATADOG_API_KEY>` by your [Datadog API Key][10].
- _Note_: For the EU region, replace `.com` by `.eu` in the endpoint.

For the Aqua Enforcer logs: **Available for Agent >6.0**

5. Collecting logs is disabled by default in the Datadog Agent. Enable it in your [daemonset configuration][13]:
5. Collecting logs is disabled by default in the Datadog Agent. Enable it in your [daemonset configuration][11]:

```yaml
# (...)
Expand All @@ -92,19 +72,19 @@ To collect Aqua audit logs:
# (...)
```

Make sure that the Docker socket is mounted to the Datadog Agent as done in [this manifest][14].
Make sure that the Docker socket is mounted to the Datadog Agent as done in [this manifest][12].

6. [Restart the Agent][11].
6. [Restart the Agent][9].

### Validation

[Run the Agent's `status` subcommand][15] and look for `aqua` under the Checks section.
[Run the Agent's `status` subcommand][13] and look for `aqua` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][16] for a list of metrics provided by this integration.
See [metadata.csv][14] for a list of metrics provided by this integration.

### Service Checks

Expand All @@ -118,22 +98,20 @@ Aqua does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][17].
Need help? Contact [Datadog support][15].

[1]: https://www.aquasec.com
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/
[4]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=agentpriorto68
[5]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=docker
[6]: https://docs.datadoghq.com/developers/integrations/new_check_howto/#developer-toolkit
[7]: https://app.datadoghq.com/account/settings#agent
[8]: https://docs.datadoghq.com/getting_started/integrations/
[9]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
[10]: https://github.com/DataDog/integrations-extras/blob/master/aqua/datadog_checks/aqua/data/conf.yaml.example
[11]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[12]: https://app.datadoghq.com/account/settings#api
[13]: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/#log-collection
[14]: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/#create-manifest
[15]: https://docs.datadoghq.com/agent/guide/agent-commands/#service-status
[16]: https://github.com/DataDog/integrations-extras/blob/master/aqua/metadata.csv
[17]: https://docs.datadoghq.com/help/
[6]: https://docs.datadoghq.com/getting_started/integrations/
[7]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
[8]: https://github.com/DataDog/integrations-extras/blob/master/aqua/datadog_checks/aqua/data/conf.yaml.example
[9]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[10]: https://app.datadoghq.com/account/settings#api
[11]: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/#log-collection
[12]: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/#create-manifest
[13]: https://docs.datadoghq.com/agent/guide/agent-commands/#service-status
[14]: https://github.com/DataDog/integrations-extras/blob/master/aqua/metadata.csv
[15]: https://docs.datadoghq.com/help/
56 changes: 18 additions & 38 deletions bind9/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,20 @@ The Bind9 check is **NOT** included in the [Datadog Agent][2] package.

### Installation

If you are using Agent v6.8+ follow the instructions below to install the Bind9 check on your host. See our dedicated Agent guide for [installing community integrations][3] to install checks with the [Agent prior v6.8][4] or the [Docker Agent][5]:
If you are using Agent v6.8+ follow the instructions below to install the Bind9 check on your host. See the dedicated Agent guide for [installing community integrations][3] to install checks with the [Agent prior v6.8][4] or the [Docker Agent][5]:

1. Install the [developer toolkit][6].
2. Clone the integrations-extras repository:
1. [Download and launch the Datadog Agent][2].
2. Run the following command to install the integrations wheel with the Agent:

```shell
git clone https://github.com/DataDog/integrations-extras.git.
datadog-agent integration install -t datadog-bind9==<INTEGRATION_VERSION>
```

3. Update your `ddev` config with the `integrations-extras/` path:

```shell
ddev config set extras ./integrations-extras
```

4. To build the `bind9` package, run:

```shell
ddev -e release build bind9
```

5. [Download and launch the Datadog Agent][2].
6. Run the following command to install the integrations wheel with the Agent:

```shell
datadog-agent integration install -w <PATH_OF_BIND9_ARTIFACT>/<BIND9_ARTIFACT_NAME>.whl
```

7. Configure your integration like [any other packaged integration][7].

3. Configure your integration like [any other packaged integration][6].

### Configuration

1. Edit the `bind9.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][8] to start collecting your Bind9 [metrics](#metrics). See the [sample bind9.d/conf.yaml][9] for all available configuration options.
1. Edit the `bind9.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][7] to start collecting your Bind9 [metrics](#metrics). See the [sample bind9.d/conf.yaml][8] for all available configuration options.

```yaml
init_config:
Expand All @@ -55,11 +36,11 @@ If you are using Agent v6.8+ follow the instructions below to install the Bind9
- URL: "<BIND_9_STATS_URL>"
```
2. [Restart the Agent][10]
2. [Restart the Agent][9]
### Validation
[Run the Agent's `status` subcommand][11] and look for `bind9` under the Checks section.
[Run the Agent's `status` subcommand][10] and look for `bind9` under the Checks section.

## Compatibility

Expand All @@ -69,7 +50,7 @@ The check is compatible with all major platforms.

### Metrics

See [metadata.csv][12] for a list of metrics provided by this integration.
See [metadata.csv][11] for a list of metrics provided by this integration.

### Events

Expand All @@ -82,18 +63,17 @@ The bind9_check check does not include any event at this time.

## Development

Please refer to the [main documentation][13] for more details about how to test and develop Agent based integrations.
Please refer to the [main documentation][12] for more details about how to test and develop Agent based integrations.

[1]: https://raw.githubusercontent.com/DataDog/integrations-extras/master/bind9/images/snapshot.png
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/
[4]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=agentpriorto68
[5]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=docker
[6]: https://docs.datadoghq.com/developers/integrations/new_check_howto/#developer-toolkit
[7]: https://docs.datadoghq.com/getting_started/integrations/
[8]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[9]: https://github.com/DataDog/integrations-extras/blob/master/bind9/datadog_checks/bind9/data/conf.yaml.example
[10]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[11]: https://docs.datadoghq.com/agent/guide/agent-commands/#service-status
[12]: https://github.com/DataDog/cookiecutter-datadog-check/blob/master/%7B%7Bcookiecutter.check_name%7D%7D/metadata.csv
[13]: https://docs.datadoghq.com/developers/
[6]: https://docs.datadoghq.com/getting_started/integrations/
[7]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[8]: https://github.com/DataDog/integrations-extras/blob/master/bind9/datadog_checks/bind9/data/conf.yaml.example
[9]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[10]: https://docs.datadoghq.com/agent/guide/agent-commands/#service-status
[11]: https://github.com/DataDog/integrations-extras/blob/master/bind9/metadata.csv
[12]: https://docs.datadoghq.com/developers/
41 changes: 24 additions & 17 deletions cyral/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,20 @@ Follow the instructions below to install and configure this check for an Agent r

### Installation

To install the Cyral check on your host:
If you are using Agent v6.8+ follow the instructions below to install the Cyral check on your host. See the dedicated Agent guide for [installing community integrations][3] to install checks with the [Agent prior v6.8][4] or the [Docker Agent][5]:

1. Install the [developer toolkit][8] on any machine.
2. Run `ddev release build cyral` to build the package.
3. [Download the Datadog Agent][9].
4. Upload the build artifact to any host with an Agent and run `datadog-agent integration install -w path/to/cyral/dist/<ARTIFACT_NAME>.whl`.
1. [Download and launch the Datadog Agent][9].
2. Run the following command to install the integrations wheel with the Agent:

```shell
datadog-agent integration install -t datadog-cyral==<INTEGRATION_VERSION>
```

3. Configure your integration like [any other packaged integration][7].

### Configuration

1. Edit the `cyral.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your cyral performance data. See the [sample cyral.d/conf.yaml][3] for all available configuration options.
1. Edit the `cyral.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your cyral performance data. See the [sample cyral.d/conf.yaml][8] for all available configuration options.

```yaml
init_config:
Expand All @@ -29,17 +33,17 @@ To install the Cyral check on your host:
- prometheus_url: http://localhost:9018/metrics
```
2. [Restart the Agent][4].
2. [Restart the Agent][9].
### Validation
[Run the Agent's status subcommand][5] and look for `cyral` under the Checks section.
[Run the Agent's status subcommand][10] and look for `cyral` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][6] for a list of metrics provided by this check.
See [metadata.csv][11] for a list of metrics provided by this check.

### Service Checks

Expand All @@ -62,14 +66,17 @@ Cyral does not include any events.

Check that the `url` in `cyral.yaml` is correct.

Need help? Contact [Datadog support][7].
Need help? Contact [Datadog support][12].

[1]: https://cyral.com/
[2]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[3]: https://github.com/DataDog/integrations-extras/blob/master/cyral/datadog_checks/cyral/data/conf.yaml.example
[4]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[6]: https://github.com/DataDog/integrations-extras/blob/master/cyral/metadata.csv
[7]: https://docs.datadoghq.com/help/
[8]: https://docs.datadoghq.com/developers/integrations/new_check_howto/#developer-toolkit
[9]: https://app.datadoghq.com/account/settings#agent
[3]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/
[4]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=agentpriorto68
[5]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=docker
[6]: https://app.datadoghq.com/account/settings#agent
[7]: https://docs.datadoghq.com/getting_started/integrations/
[8]: https://github.com/DataDog/integrations-extras/blob/master/cyral/datadog_checks/cyral/data/conf.yaml.example
[9]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[10]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[11]: https://github.com/DataDog/integrations-extras/blob/master/cyral/metadata.csv
[12]: https://docs.datadoghq.com/help/
58 changes: 19 additions & 39 deletions eventstore/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,46 +11,27 @@ Get metrics from EventStore in real time to:

### Installation

If you are using Agent v6.8+ follow the instructions below to install the EventStore check on your host. See our dedicated Agent guide for [installing community integrations][1] to install checks with the [Agent prior to version 6.8][2] or the [Docker Agent][3]:
If you are using Agent v6.8+ follow the instructions below to install the EventStore check on your host. See the dedicated Agent guide for [installing community integrations][1] to install checks with the [Agent prior to version 6.8][2] or the [Docker Agent][3]:

1. Install the [developer toolkit][4].
2. Clone the integrations-extras repository:
1. [Download and launch the Datadog Agent][4].
2. Run the following command to install the integrations wheel with the Agent:

```shell
git clone https://github.com/DataDog/integrations-extras.git.
datadog-agent integration install -t datadog-eventstore==<INTEGRATION_VERSION>
```

3. Update your `ddev` config with the `integrations-extras/` path:

```shell
ddev config set extras ./integrations-extras
```

4. To build the `eventstore` package, run:

```shell
ddev -e release build eventstore
```

5. [Download and launch the Datadog Agent][5].
6. Run the following command to install the integrations wheel with the Agent:

```shell
datadog-agent integration install -w <PATH_OF_EVENTSTORE_ARTIFACT_>/<EVENTSTORE_ARTIFACT_NAME>.whl
```

7. Configure your integration like [any other packaged integration][6].
3. Configure your integration like [any other packaged integration][5].

### Configuration

1. Edit the `eventstore.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][7] to start collecting your EventStore [metrics](#metrics).
See the [sample eventstore.d/conf.yaml][8] for all available configuration options.
1. Edit the `eventstore.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][6] to start collecting your EventStore [metrics](#metrics).
See the [sample eventstore.d/conf.yaml][7] for all available configuration options.

2. [Restart the Agent][9].
2. [Restart the Agent][8].

### Validation

[Run the Agent's status subcommand][10] and look for `eventstore` under the Checks section.
[Run the Agent's status subcommand][9] and look for `eventstore` under the Checks section.

## Compatibility

Expand All @@ -60,7 +41,7 @@ The check is compatible with all major platforms.

### Metrics

See [metadata.csv][11] for a list of metrics provided by this integration.
See [metadata.csv][10] for a list of metrics provided by this integration.

### Events

Expand All @@ -72,17 +53,16 @@ The eventstore check does not include any service checks.

## Troubleshooting

Need help? Contact the [maintainer][12] of this integration.
Need help? Contact the [maintainer][11] of this integration.

[1]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/
[2]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=agentpriorto68
[3]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent/?tab=docker
[4]: https://docs.datadoghq.com/developers/integrations/new_check_howto/#developer-toolkit
[5]: https://app.datadoghq.com/account/settings#agent
[6]: https://docs.datadoghq.com/getting_started/integrations/
[7]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[8]: https://github.com/DataDog/integrations-extras/blob/master/eventstore/datadog_checks/eventstore/data/conf.yaml.example
[9]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-restart-the-agent
[10]: https://docs.datadoghq.com/agent/guide/agent-commands/#service-status
[11]: https://github.com/DataDog/integrations-extras/blob/master/eventstore/metadata.csv
[12]: https://github.com/DataDog/integrations-extras/blob/master/eventstore/manifest.json
[4]: https://app.datadoghq.com/account/settings#agent
[5]: https://docs.datadoghq.com/getting_started/integrations/
[6]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[7]: https://github.com/DataDog/integrations-extras/blob/master/eventstore/datadog_checks/eventstore/data/conf.yaml.example
[8]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-restart-the-agent
[9]: https://docs.datadoghq.com/agent/guide/agent-commands/#service-status
[10]: https://github.com/DataDog/integrations-extras/blob/master/eventstore/metadata.csv
[11]: https://github.com/DataDog/integrations-extras/blob/master/eventstore/manifest.json
Loading

0 comments on commit 00dca3b

Please sign in to comment.