elastic-cloud plugin

Contents

Usage

This section documents the behavior of the elastic-cloud plugin when using the CLI.

Before using the elastic-cloud plugin you must have its prerequisites.

setup

Elastic will charge you for your use of Elastic Cloud after a 14-day free trial (more info).

When running microbs setup [-o], the elastic-cloud plugin creates an Elastic Cloud deployment using the Elastic Cloud API. Then it deploys filebeat, metricbeat, and heartbeat services to the Kubernetes cluster. These agents autodiscover logs and metrics from the Kubernetes nodes and pods and ships that data to the Elastic Cloud deployment.

rollout

The elastic-cloud plugin is unaffected by microbs rollout.

destroy

When running microbs destroy [-o], the elastic-cloud plugin destroys your Elastic Cloud deployment using the Elastic Cloud API. It also removes the services that were deployed to Kubernetes during setup.

Prerequisites

Create Elastic Cloud resources

You must create an Elastic Cloud account and obtain an Elastic Cloud API Key before using the elastic-cloud plugin.

Configuration

This section documents the elastic-cloud plugin configurations for config.yaml.

Required fields

plugins.elastic-cloud.api_key

The value of your Elastic Cloud API Key.

Example: VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw==

plugins.elastic-cloud.region

The name of the region in which to deploy your Elastic Cloud deployment.

See the available regions for a list of acceptable values.

Examples: gcp-us-east1, ap-east1, westeurope

plugins.elastic-cloud.version

The version of the Elastic Stack to deploy.

Examples: 8.2.0

© 2022 Dave Moore.
Licensed under the Apache License, Version 2.0.
This website uses Google Analytics.

microbs is a project of the open source community. microbs is not officially supported by any vendors named in this documentation or the software (e.g. Cloud Native Computing Foundation, Amazon, Google, Microsoft, Elastic, Grafana), though employees or partners of those vendors may contribute to the project.