Skip to content

Commit e321f06

Browse files
authored
Add mention to stack providers in README and stack up help (#2361)
1 parent b6b74e5 commit e321f06

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,11 @@ For details on how to connect the service with the Elastic stack, see the [servi
514514

515515
You can customize your stack using profile settings, see [Elastic Package profiles](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-profiles-1) section. These settings can be also overriden with the --parameter flag. Settings configured this way are not persisted.
516516

517+
There are different providers supported, that can be selected with the --provider flag.
518+
- compose: Starts a local stack using Docker Compose. This is the default.
519+
- environment: Prepares an existing stack to be used to test packages. Missing components are started locally using Docker Compose. Environment variables are used to configure the access to the existing Elasticsearch and Kibana instances.
520+
- serverless: Uses Elastic Cloud to start a serverless project. Requires an Elastic Cloud API key.
521+
517522
### `elastic-package stack update`
518523

519524
_Context: global_

cmd/stack.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@ To expose local packages in the Package Registry, build them first and boot up t
4747
4848
For details on how to connect the service with the Elastic stack, see the [service command](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-service).
4949
50-
You can customize your stack using profile settings, see [Elastic Package profiles](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-profiles-1) section. These settings can be also overriden with the --parameter flag. Settings configured this way are not persisted.`
50+
You can customize your stack using profile settings, see [Elastic Package profiles](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-profiles-1) section. These settings can be also overriden with the --parameter flag. Settings configured this way are not persisted.
51+
52+
There are different providers supported, that can be selected with the --provider flag.
53+
- compose: Starts a local stack using Docker Compose. This is the default.
54+
- environment: Prepares an existing stack to be used to test packages. Missing components are started locally using Docker Compose. Environment variables are used to configure the access to the existing Elasticsearch and Kibana instances.
55+
- serverless: Uses Elastic Cloud to start a serverless project. Requires an Elastic Cloud API key.`
5156

5257
const stackShellinitLongDescription = `Use this command to export to the current shell the configuration of the stack managed by elastic-package.
5358

0 commit comments

Comments
 (0)