ybm integration

Manage integration configuration

This page documents the preview (v2.21) version. Preview includes features under active development and is for development and testing only. For production, use the stable (v2024.1) version.

Use the integration resource to create integration configurations for third-party tools. Integrations can then be assigned to clusters to export metrics and logs to third-party tools.

Syntax

Usage: ybm integration [command] [flags]

Example

Create a configuration:

ybm integration create \
    --config-name datadog1 \
    --type DATADOG \
    --datadog-spec api-key=efXXXXXXXXXXXXXXXXXXXXXXXXXXXXee,site=US1

Assign the configuration to a cluster:

ybm integration assign \
    --cluster-name my_cluster \
    --config-name datadog1

Commands

assign

Assign an integration configuration to the specified cluster.

Flag Description
--cluster-name Required. Name of the cluster.
--config-name Required. Name of the integration configuration.

create

Create an integration configuration.

Flag Description
--config-name Required. Name for the integration configuration.
--type Required. The third party tool to export to. Options: DATADOG, GRAFANA, SUMOLOGIC.
--datadog-spec Required for type DATADOG. The Datadog export details, provided as key-value pairs.
Arguments:
  • api-key - your Datadog API key.
  • site - your Datadog site parameters.
--grafana-spec Required for type GRAFANA. The Grafana Cloud export details, provided as key-value pairs.
Arguments:
  • access-policy-token - your Grafana Cloud token.
  • org-slug - your organization name.
  • instance-id - your Grafana Cloud instance ID.
  • zone - your Grafana Cloud instance zone.
--sumologic-spec Required for type SUMOLOGIC. The Sumo Logic export details, provided as key-value pairs.
Arguments:
  • access-key - your Sumo Logic access key.
  • access-id - your Sumo Logic access ID.
  • installation-token - your Sumo Logic installation token.

delete

Delete a specified integration configuration. You can't delete configurations that are in use by a cluster.

Flag Description
--config-name Required. Name of the integration configuration.

list

List the integration configurations.

unassign

Remove the integration configuration from the specified cluster.

Flag Description
--cluster-name Required. Name of the cluster.

update

Update an integration configuration.

Flag Description
--config-name Required. Name of the integration configuration.
--new-config-name New name for the integration configuration.
--type Required. The third party tool to exported metrics to. Options: DATADOG, GRAFANA, SUMOLOGIC.
--datadog-spec Required for type DATADOG. The Datadog export details, provided as key-value pairs.
Arguments:
  • api-key - your Datadog API key.
  • site - your Datadog site parameters.
--grafana-spec Required for type GRAFANA. The Grafana Cloud export details, provided as key-value pairs.
Arguments:
  • access-policy-token - your Grafana Cloud token.
  • org-slug - your organization name.
  • instance-id - your Grafana Cloud instance ID.
  • zone - your Grafana Cloud instance zone.
--sumologic-spec Required for type SUMOLOGIC. The Sumo Logic export details, provided as key-value pairs.
Arguments:
  • access-key - your Sumo Logic access key.
  • access-id - your Sumo Logic access ID.
  • installation-token - your Sumo Logic installation token.