mirror of https://github.com/hashicorp/consul
snapshot agent: docs to deprecate top-level snapshot destinations (#20848)
parent
223714bdea
commit
217e5e1d78
|
@ -133,6 +133,8 @@ Usage: `consul snapshot agent [options]`
|
||||||
Config files referenced using `-config-dir` and `-config-file` have the following
|
Config files referenced using `-config-dir` and `-config-file` have the following
|
||||||
format (shown populated with default values):
|
format (shown populated with default values):
|
||||||
|
|
||||||
|
~> Top-level single snapshot destinations in a config file are deprecated and will be removed in a future version. Move top-level `local_storage`, `aws_storage`, `azure_blob_storage`, and `google_storage` config objects to `snapshot_agent -> backup_destinations` instead.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"snapshot_agent": {
|
"snapshot_agent": {
|
||||||
|
@ -149,7 +151,7 @@ Usage: `consul snapshot agent [options]`
|
||||||
"auth_method": "",
|
"auth_method": "",
|
||||||
"bearer_token": "",
|
"bearer_token": "",
|
||||||
"bearer_token_file": "",
|
"bearer_token_file": "",
|
||||||
"meta": {},
|
"meta": {}
|
||||||
},
|
},
|
||||||
"log": {
|
"log": {
|
||||||
"level": "INFO",
|
"level": "INFO",
|
||||||
|
@ -193,7 +195,7 @@ Usage: `consul snapshot agent [options]`
|
||||||
"account_name": "",
|
"account_name": "",
|
||||||
"account_key": "",
|
"account_key": "",
|
||||||
"container_name": ""
|
"container_name": ""
|
||||||
},
|
}
|
||||||
],
|
],
|
||||||
"google_storage": [
|
"google_storage": [
|
||||||
{
|
{
|
||||||
|
@ -270,6 +272,9 @@ if desired.
|
||||||
- `login-meta` - Metadata to set on the token, formatted as key=value. This flag may be provided multiple times.
|
- `login-meta` - Metadata to set on the token, formatted as key=value. This flag may be provided multiple times.
|
||||||
|
|
||||||
#### Local Storage Options
|
#### Local Storage Options
|
||||||
|
|
||||||
|
~> This option is deprecated when used with a top-level `local_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> local_storage[0]` in a config file instead.
|
||||||
|
|
||||||
This option cannot be used when using `backup_destinations` in a config file.
|
This option cannot be used when using `backup_destinations` in a config file.
|
||||||
|
|
||||||
- `-local-path` - Location to store snapshots locally. The default behavior
|
- `-local-path` - Location to store snapshots locally. The default behavior
|
||||||
|
@ -279,6 +284,9 @@ This option cannot be used when using `backup_destinations` in a config file.
|
||||||
be ignored.
|
be ignored.
|
||||||
|
|
||||||
#### S3 Storage Options
|
#### S3 Storage Options
|
||||||
|
|
||||||
|
~> These options are deprecated when used with a top-level `aws_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> aws_storage[0]` in a config file instead.
|
||||||
|
|
||||||
These options cannot be used when using `backup_destinations` in a config file.
|
These options cannot be used when using `backup_destinations` in a config file.
|
||||||
Note that despite the AWS references, any S3-compatible endpoint can be specified with `-aws-s3-endpoint`.
|
Note that despite the AWS references, any S3-compatible endpoint can be specified with `-aws-s3-endpoint`.
|
||||||
|
|
||||||
|
@ -374,6 +382,8 @@ The following example IAM policy document assumes that the `aws-s3-bucket` is `c
|
||||||
|
|
||||||
#### Azure Blob Storage options
|
#### Azure Blob Storage options
|
||||||
|
|
||||||
|
~> These options are deprecated when used with a top-level `azure_blob_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> azure_blob_storage[0]` in a config file instead.
|
||||||
|
|
||||||
** Note: This currently only works on non-Solaris platforms due to library limitations **
|
** Note: This currently only works on non-Solaris platforms due to library limitations **
|
||||||
|
|
||||||
From Consul Enterprise version `1.5.0` onwards, you can store snapshots in Azure Blob storage.
|
From Consul Enterprise version `1.5.0` onwards, you can store snapshots in Azure Blob storage.
|
||||||
|
@ -391,6 +401,8 @@ These options cannot be used when using `backup_destinations` in a config file.
|
||||||
|
|
||||||
#### Google Cloud Storage options
|
#### Google Cloud Storage options
|
||||||
|
|
||||||
|
~> This option is deprecated when used with a top-level `google_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> google_storage[0]` in a config file instead.
|
||||||
|
|
||||||
From Consul Enterprise version `1.6.1` onwards, you can store snapshots in Google Cloud Storage. Authentication relies on automatic discovery through the sdk as described [here](https://cloud.google.com/docs/authentication/production):
|
From Consul Enterprise version `1.6.1` onwards, you can store snapshots in Google Cloud Storage. Authentication relies on automatic discovery through the sdk as described [here](https://cloud.google.com/docs/authentication/production):
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
layout: docs
|
||||||
|
page_title: 1.19.x
|
||||||
|
description: >-
|
||||||
|
Consul release notes for version 1.19.x
|
||||||
|
---
|
||||||
|
|
||||||
|
# Consul 1.19.0
|
||||||
|
|
||||||
|
We are pleased to announce the following Consul updates.
|
||||||
|
|
||||||
|
## Release highlights
|
||||||
|
|
||||||
|
- TBD
|
||||||
|
|
||||||
|
## What's deprecated
|
||||||
|
|
||||||
|
- **Snapshot Agent (Enterprise):** Starting with this release, top level single snapshot destinations `local_storage`, `aws_storage`, `azure_blob_storage`, and `google_storage` in snapshot agent configuration files are deprecated. Use the [`backup_destinations`](/consul/commands/snapshot/agent#config-file) config object instead.
|
||||||
|
|
||||||
|
## Upgrading
|
||||||
|
|
||||||
|
For more detailed information, please refer to the [upgrade details page](/consul/docs/upgrading/upgrade-specific) and the changelogs.
|
||||||
|
|
||||||
|
## Known issues
|
||||||
|
|
||||||
|
The following issues are known to exist in the v1.19.x releases:
|
||||||
|
|
||||||
|
## Changelogs
|
||||||
|
|
||||||
|
The changelogs for this major release version and any maintenance versions are listed below.
|
||||||
|
|
||||||
|
<Note> These links take you to the changelogs on the GitHub website. </Note>
|
||||||
|
|
||||||
|
- [1.19.0](https://github.com/hashicorp/consul/releases/tag/v1.19.0)
|
|
@ -166,6 +166,10 @@
|
||||||
{
|
{
|
||||||
"title": "Consul",
|
"title": "Consul",
|
||||||
"routes": [
|
"routes": [
|
||||||
|
{
|
||||||
|
"title": "v1.19.x",
|
||||||
|
"path": "release-notes/consul/v1_19_x"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "v1.18.x",
|
"title": "v1.18.x",
|
||||||
"path": "release-notes/consul/v1_18_x"
|
"path": "release-notes/consul/v1_18_x"
|
||||||
|
|
Loading…
Reference in New Issue