Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add s3 remote state doc #548

Merged
merged 1 commit into from
May 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/core-concepts/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,11 @@ tools:

### State

The `state` section specifies where to store DevStream state. As of now (v0.5.0,) we only support local "backend" to store the DevStream state. AWS S3 backend is being supported and will be released soon.
The `state` section specifies where to store DevStream state. As of now (v0.5.0), we only support local backend.

The `state` section has some options. For example, `stateFile` is mandatory for local backend.
From v0.6.0 on, we will support both "local" and "s3" backend store the DevStream state.

Read the section [The State Section in the Main Config](./stateconfig.md) for more details.

## Default Values

Expand Down
20 changes: 0 additions & 20 deletions docs/core-concepts/state.md

This file was deleted.

40 changes: 40 additions & 0 deletions docs/core-concepts/stateconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# The State Section in the Main Config

In the main config, we can specify which "backend" to use to store DevStream state.

We support the following types of backend:

- local
- s3

## Local backend config example:

```yaml
varFile: variables-gitops.yaml

toolFile: tools-gitops.yaml

state:
backend: local
options:
stateFile: devstream.state
```

The `stateFile` under the `options` section is mandatory for local backend.

## S3 backend config example:

```yaml
varFile: variables-gitops.yaml

toolFile: tools-gitops.yaml

state:
backend: s3
options:
bucket: devstream-remote-state
region: ap-southeast-1
key: devstream.state
```

The `bucket`, `region`, and `key` under the `ptions` section are all mandatory fields for s3 backend.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ nav:
- 'core-concepts/core-concepts.md'
- 'core-concepts/config.md'
- 'core-concepts/variables.md'
- 'core-concepts/state.md'
- 'core-concepts/stateconfig.md'
- 'core-concepts/dependencies.md'
- 'core-concepts/output.md'
- Plugins:
Expand Down