microbs plugin - elastic-cloud
npm install @microbs.io/plugin-elastic-cloud
!Apache 2.0
* Usage
* Prerequisites
* Configuration
Before using the elastic-cloud plugin you must meet its prerequisites.
> Elastic will charge you for your use of Elastic Cloud after a 14-day free trial (more info).
When running [microbs setup [-o]](https://microbs.io/docs/usage/cli/#setup), theelastic-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.
The elastic-cloud plugin is unaffected by microbs rollout.
When running [microbs destroy [-o]](https://microbs.io/docs/usage/cli/#destroy), theelastic-cloud plugin destroys your Elastic Cloud deployment using the
Elastic Cloud API.
It also removes the services that were deployed to Kubernetes
during setup.
microbs installs this plugin automatically when you install microbs.
To reinstall this plugin, run this command:
microbs plugins install elastic-cloud
To upgrade this plugin to the latest version, run this command:
microbs plugins update elastic-cloud
You must create an Elastic Cloud account
and obtain an Elastic Cloud API Key
before using the elastic-cloud plugin.
This section documents the elastic-cloud plugin configurations for config.yaml.
#### [](plugins.elastic-cloud.api_key)plugins.elastic-cloud.api_key
The value of your Elastic Cloud API Key.
Example: VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw==
#### [](plugins.elastic-cloud.region)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)plugins.elastic-cloud.version
The version of the Elastic Stack to deploy.
Examples: 8.2.0