Enable Section Summary TOC for small pages
This commit is contained in:
Marcin Grzejszczak
committed by
spencergibb
spencergibb
parent
8b8e55d747
commit
b5fa7dcac0
@@ -2,6 +2,7 @@
|
||||
|
||||
[[observability]]
|
||||
= Observability metadata
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
include::{root-target}_metrics.adoc[]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-config]]
|
||||
= Spring Cloud Config
|
||||
:page-section-summary-toc: 1
|
||||
:github: https://github.com/spring-cloud/spring-cloud-config
|
||||
:githubmaster: {github}/tree/master
|
||||
:docslink: {githubmaster}/docs/src/main/asciidoc
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[quick-start]]
|
||||
= Quick Start
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
include:../:quickstart.adoc[]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[-aot-and-native-image-support]]
|
||||
= AOT and Native Image Support
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Since `4.0.0`, Spring Cloud Config Server supports Spring AOT transformations. However, for the time being, GraalVM native images are not supported. Implementing native image support is blocked by https://github.com/oracle/graal/issues/5134[graal#5134] and will likely require the completion of the work on https://github.com/graalvm/taming-build-time-initialization[https://github.com/graalvm/taming-build-time-initialization] to be fixed.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[actuator-and-security]]
|
||||
= Actuator and Security
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
IMPORTANT: Some platforms configure health checks or something similar and point to `/actuator/health` or other actuator endpoints. If actuator is not a dependency of config server, requests to `/actuator/**` would match the config server API `/{application}/{label}` possibly leaking secure information. Remember to add the `spring-boot-starter-actuator` dependency in this case and configure the users such that the user that makes calls to `/actuator/**` does not have access to the config server API at `/{application}/{label}`.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[aws-parameter-store]]
|
||||
= AWS Parameter Store
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
When using AWS Parameter Store as a backend, you can share configuration with all applications by placing properties within the `/application` hierarchy.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[file-system-backend]]
|
||||
= File System Backend
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
There is also a "`native`" profile in the Config Server that does not use Git but loads the config files from the local classpath or file system (any static URL you want to point to with `spring.cloud.config.server.native.searchLocations`).
|
||||
To use the native profile, launch the Config Server with `spring.profiles.active=native`.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[jdbc-backend]]
|
||||
= JDBC Backend
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Spring Cloud Config Server supports JDBC (relational database) as a backend for configuration properties.
|
||||
You can enable this feature by adding `spring-boot-starter-data-jdbc` to the classpath and using the `jdbc` profile or by adding a bean of type `JdbcEnvironmentRepository`.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[overriding-properties-using-placeholders]]
|
||||
= Overriding Properties Using Placeholders
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
A cleaner way to override properties without enabling config first bootstrap is to use property placeholders in the configuration coming from the config server.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[overriding-properties-using-profiles]]
|
||||
= Overriding Properties Using Profiles
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The final way to override properties coming from the config server is to specify them in profile specific configuration file within the client
|
||||
application.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-bootstrap-to-override-properties]]
|
||||
= Using Bootstrap To Override Properties
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
If you enable xref:spring-cloud-config/client.adoc#config-first-bootstrap[config first bootstrap], you can allow client applications to override configuration from the config server by placing two properties within
|
||||
the applications configuration coming from the config server.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[version-control-backend-filesystem-use]]
|
||||
= Version Control Backend Filesystem Use
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
WARNING: With VCS-based backends (git, svn), files are checked out or cloned to the local filesystem.
|
||||
By default, they are put in the system temporary directory with a prefix of `config-repo-`.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[push-notifications-and-spring-cloud-bus]]
|
||||
= Push Notifications and Spring Cloud Bus
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Many source code repository providers (such as Github, Gitlab, Gitea, Gitee, Gogs, or Bitbucket) notify you of changes in a repository through a webhook.
|
||||
You can configure the webhook through the provider's user interface as a URL and a set of events in which you are interested.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[security]]
|
||||
= Security
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
You can secure your Config Server in any way that makes sense to you (from physical network security to OAuth2 bearer tokens), because Spring Security and Spring Boot offer support for many security arrangements.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[serving-alternative-formats]]
|
||||
= Serving Alternative Formats
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The default JSON format from the environment endpoints is perfect for consumption by Spring applications, because it maps directly onto the `Environment` abstraction.
|
||||
If you prefer, you can consume the same data as YAML or Java properties by adding a suffix (".yml", ".yaml" or ".properties") to the resource path.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[serving-encrypted-properties]]
|
||||
= Serving Encrypted Properties
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Sometimes you want the clients to decrypt the configuration locally, instead of doing it in the server.
|
||||
In that case, if you provide the `encrypt.*` configuration to locate a key, you can still have `/encrypt` and `/decrypt` endpoints, but you need to explicitly switch off the decryption of outgoing properties by placing `spring.cloud.config.server.encrypt.enabled=false` in `bootstrap.[yml|properties]`.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[serving-plain-text]]
|
||||
= Serving Plain Text
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Instead of using the `Environment` abstraction (or one of the alternative representations of it in YAML or properties format), your applications might need generic plain-text configuration files that are tailored to their environment.
|
||||
The Config Server provides these through an additional endpoint at `/{application}/{profile}/{label}/{path}`, where `application`, `profile`, and `label` have the same meaning as the regular environment endpoint, but `path` is a path to a file name (such as `log.xml`).
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[using-multiple-keys-and-key-rotation]]
|
||||
= Using Multiple Keys and Key Rotation
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
In addition to the `{cipher}` prefix in encrypted property values, the Config Server looks for zero or more `{name:value}` prefixes before the start of the (Base64 encoded) cipher text.
|
||||
The keys are passed to a `TextEncryptorLocator`, which can do whatever logic it needs to locate a `TextEncryptor` for the cipher.
|
||||
|
||||
Reference in New Issue
Block a user