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

[8.0] [DOCS] Fix headings for Azure, GCS, and S3 snapshot repo pages (#82996) #83001

Merged
merged 1 commit into from
Jan 24, 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
4 changes: 2 additions & 2 deletions docs/reference/snapshot-restore/repository-azure.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[[repository-azure]]
=== Azure Repository
=== Azure repository

You can use https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction[Azure Blob storage] as a repository for
{ref}/modules-snapshots.html[Snapshot/Restore].

[[repository-azure-usage]]
==== Azure Repository
==== Setup

To enable Azure repositories, you have first to define your azure storage settings as
{ref}/secure-settings.html[secure settings], before starting up the node:
Expand Down
24 changes: 7 additions & 17 deletions docs/reference/snapshot-restore/repository-gcs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[repository-gcs]]
=== Google Cloud Storage Repository
=== Google Cloud Storage repository

You can use the https://cloud.google.com/storage/[Google Cloud Storage]
service as a repository for {ref}/modules-snapshots.html[Snapshot/Restore].
Expand All @@ -15,7 +15,7 @@ and create a new project. After your project is created, you must enable the
Cloud Storage Service for your project.

[[repository-gcs-creating-bucket]]
===== Creating a Bucket
===== Creating a bucket

The Google Cloud Storage service uses the concept of a
https://cloud.google.com/storage/docs/key-terms[bucket] as a container for all
Expand All @@ -38,7 +38,7 @@ For more detailed instructions, see the
https://cloud.google.com/storage/docs/quickstart-console#create_a_bucket[Google Cloud documentation].

[[repository-gcs-service-authentication]]
===== Service Authentication
===== Service authentication

The repository must authenticate the requests it makes to the Google Cloud Storage
service. It is common for Google client libraries to employ a strategy named https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application[application default credentials].
Expand All @@ -54,7 +54,7 @@ credentials if you are using an environment that does not support automatic
credential discovery.

[[repository-gcs-using-service-account]]
===== Using a Service Account
===== Using a service account
You have to obtain and provide https://cloud.google.com/iam/docs/overview#service_account[service account credentials]
manually.

Expand Down Expand Up @@ -125,7 +125,7 @@ of the client's `credentials_file` settings. They complete using the client as
it was built when the operation started.

[[repository-gcs-client]]
==== Client Settings
==== Client settings

The client used to connect to Google Cloud Storage has a number of settings available.
Client setting names are of the form `gcs.client.CLIENT_NAME.SETTING_NAME` and are specified
Expand Down Expand Up @@ -191,18 +191,8 @@ are marked as `Secure`.
can be specified explicitly. For example, it can be used to switch between projects when the
same credentials are usable for both the production and the development projects.

`proxy.host`::
The host name of a proxy to connect to the Google Cloud Storage through.

`proxy.port`::
The port of a proxy to connect to the Google Cloud Storage through.

`proxy.type`::
The proxy type for the client. Supported values are `direct`, `http`, and `socks`.
The default value is `direct` (no proxy).

[[repository-gcs-repository]]
==== Repository Settings
==== Repository settings

The `gcs` repository type supports a number of settings to customize how data
is stored in Google Cloud Storage.
Expand Down Expand Up @@ -262,7 +252,7 @@ include::repository-shared-settings.asciidoc[]
Name used by the client when it uses the Google Cloud Storage service.

[[repository-gcs-bucket-permission]]
===== Recommended Bucket Permission
===== Recommended bucket permission

The service account used to access the bucket must have the "Writer" access to the bucket:

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/snapshot-restore/repository-s3.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[[repository-s3]]
=== S3 Repository
=== S3 repository

You can use AWS S3 as a repository for {ref}/modules-snapshots.html[Snapshot/Restore].

*If you are looking for a hosted solution of Elasticsearch on AWS, please visit
https://www.elastic.co/cloud/.*

[[repository-s3-usage]]
==== Getting Started
==== Getting started

To register an S3 repository, specify the type as `s3` when creating
the repository. The repository defaults to using
Expand All @@ -30,7 +30,7 @@ PUT _snapshot/my_s3_repository


[[repository-s3-client]]
==== Client Settings
==== Client settings

The client that you use to connect to S3 has a number of settings available.
The settings have the form `s3.client.CLIENT_NAME.SETTING_NAME`. By default,
Expand Down Expand Up @@ -233,7 +233,7 @@ use as a snapshot repository. You will need to work with the supplier of your
storage system to address any incompatibilities you encounter.

[[repository-s3-repository]]
==== Repository Settings
==== Repository settings

The `s3` repository type supports a number of settings to customize how data is
stored in S3. These can be specified when creating the repository. For example:
Expand Down Expand Up @@ -359,7 +359,7 @@ This sets up a repository that uses all client settings from the client
`my.s3.endpoint` by the repository settings.

[[repository-s3-permissions]]
===== Recommended S3 Permissions
===== Recommended S3 permissions

In order to restrict the Elasticsearch snapshot process to the minimum required
resources, we recommend using Amazon IAM in conjunction with pre-existing S3
Expand Down Expand Up @@ -480,7 +480,7 @@ reach a certain age.

[[repository-s3-aws-vpc]]
[discrete]
==== AWS VPC Bandwidth Settings
==== AWS VPC bandwidth settings

AWS instances resolve S3 endpoints to a public IP. If the Elasticsearch
instances reside in a private subnet in an AWS VPC then all traffic to S3 will
Expand Down