Spring/spring-credhub
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clean up documentation

Browse Source
This commit is contained in:
Scott Frederick
2021-10-06 14:45:31 -05:00
parent 3a3237d8e2
commit 758f862be8
6 changed files with 51 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
spring-credhub-docs/build.gradle
View File

@@ -70,7 +70,8 @@ asciidoctor {
'idseparator': '-',
docinfo: 'shared',
revnumber: project.version,
'spring-version': project.version,
'spring-version': "${springVersion}",
'spring-security-version': "${springSecurityVersion}",
'branch-or-tag': project.version.endsWith('SNAPSHOT') ? 'main' : "v${project.version}",
sectanchors: '',
sectnums: '',

8
spring-credhub-docs/src/docs/asciidoc/boot-configuration.adoc
View File

@@ -1,6 +1,10 @@
:credhub-api-mtls: {credhub-api-home}version/2.0/#mutual-tls
:credhub-api-oauth: {credhub-api-home}version/2.0/#uaa-oauth2
:examples-dir: ../../src/test/java/com/example/credhub/
:credhub-api-mtls: {credhub-api-home}version/main/#_mutual_tls
:credhub-api-oauth: {credhub-api-home}version/main/#_uaa_oauth2
:spring-boot-oauth: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-security-oauth2
:spring-security-version: 5.5.2
:spring-security-apidocs-home: https://docs.spring.io/spring-security/site/docs/{spring-security-version}/api/org/springframework/security/oauth2/client/
:spring-security-ref-home: https://docs.spring.io/spring-security/site/docs/{spring-security-version}/reference/html5/
[[boot-configuration]]
== Spring Boot Configuration

42
spring-credhub-docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -1,4 +1,4 @@
:spring-webflux: https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/web-reactive.html#spring-webflux
:spring-webflux: https://docs.spring.io/spring-framework/docs/{spring-version}/reference/html/web-reactive.html#spring-webflux
:spring-security: https://spring.io/projects/spring-security
[[getting-started]]
@@ -14,57 +14,79 @@ To include Spring CredHub in a Spring Boot application, add some dependencies to
Add the Spring CredHub starter to the `dependencies` section of the build file:
[source,xml,%autofit,subs="verbatim,attributes"]
----
<dependencies>
<dependency>
<groupId>org.springframework.credhub</groupId>
<artifactId>spring-credhub-starter</artifactId>
<version>${version}</version>
<version>{revnumber}</version>
</dependency>
</dependencies>
----
To enable reactive support in Spring CredHub, add the following {spring-webflux}[Spring WebFlux] dependency to the build file:
[source,xml,%autofit]
[subs="verbatim,attributes"]
----
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
<version>2.2.6.RELEASE</version>
<version>{spring-version}</version>
</dependency>
</dependencies>
----
To use OAuth2 authentication to CredHub, add the following {spring-security}[Spring Security] dependencies to the build file:
[source,xml,%autofit]
[subs="verbatim,attributes"]
----
<dependencies>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-config</artifactId>
<version>5.2.2.RELEASE</version>
<version>{spring-security-version}</version>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-oauth2-client</artifactId>
<version>5.2.2.RELEASE</version>
<version>{spring-security-version}</version>
</dependency>
</dependencies>
----
=== Gradle Dependencies
Add the Spring CredHub starter to the `dependencies` section of the build file:
[source,groovy,%autofit]
[subs="verbatim,attributes"]
----
dependencies {
compile('org.springframework.credhub:spring-credhub-starter:${version}')
compile('org.springframework.credhub:spring-credhub-starter:{revnumber}')
}
----
To enable reactive support in Spring CredHub, add the following {spring-webflux}[Spring WebFlux] dependency to the build file:
[source,groovy,%autofit]
[subs="verbatim,attributes"]
----
dependencies {
compile("org.springframework.boot:spring-boot-starter-webflux:2.2.6.RELEASE")
compile("org.springframework.boot:spring-boot-starter-webflux:{spring-version}")
}
----
To use OAuth2 authentication to CredHub, add the following {spring-security}[Spring Security] dependencies to the build file:
[source,groovy,%autofit]
[subs="verbatim,attributes"]
----
dependencies {
compile("org.springframework.security:spring-security-config:5.2.2.RELEASE")
compile("org.springframework.security:spring-security-oauth2-client:5.2.2.RELEASE")
compile("org.springframework.security:spring-security-config:{spring-security-version}")
compile("org.springframework.security:spring-security-oauth2-client:{spring-security-version}")
}
----

17
spring-credhub-docs/src/docs/asciidoc/index.adoc
View File

@@ -10,18 +10,15 @@ Scott Frederick;
:examples-dir: ../../src/test/java/com/example/credhub/
:credhub-home: https://docs.cloudfoundry.org/credhub/
:credhub-api-home: https://credhub-api.cfapps.io/
:credhub-api-credentials: {credhub-api-home}version/master/#_credentials_endpoint
:credhub-api-certificates: {credhub-api-home}version/master/#_certificates_endpoint
:credhub-api-permissions: {credhub-api-home}version/master/#_permissions_v1_deprecated
:credhub-api-permissionsV2: {credhub-api-home}version/master/#_permissions_v2_endpoint
:credhub-api-interpolation: {credhub-api-home}version/master/#_interpolation_endpoint
:credhub-api-info: {credhub-api-home}version/master/#_info_endpoint
:credhub-api-home: https://docs.cloudfoundry.org/api/credhub/
:credhub-api-credentials: {credhub-api-home}version/main/#_credentials_endpoint
:credhub-api-certificates: {credhub-api-home}version/main/#_certificates_endpoint
:credhub-api-permissions: {credhub-api-home}version/main/#_permissions_v1_deprecated
:credhub-api-permissionsV2: {credhub-api-home}version/main/#_permissions_v2_endpoint
:credhub-api-interpolation: {credhub-api-home}version/main/#_interpolation_endpoint
:credhub-api-info: {credhub-api-home}version/main/#_info_endpoint
:cloudfoundry-home: https://www.cloudfoundry.org/
:apidocs-home: https://docs.spring.io/spring-credhub/docs/{revnumber}/api/index.html
:spring-security-version: 5.2.2.RELEASE
:spring-security-apidocs-home: https://docs.spring.io/spring-security/site/docs/{spring-security-version}/api/org/springframework/security/oauth2/client/
:spring-security-ref-home: https://docs.spring.io/spring-security/site/docs/{spring-security-version}/reference/html5/
(C) 2017-2018 The original authors.

1
spring-credhub-docs/src/docs/asciidoc/operations.adoc
View File

@@ -1,3 +1,4 @@
:examples-dir: ../../src/test/java/com/example/credhub/
:apidocs-credentials: {apidocs-home}?org/springframework/credhub/core/credential/CredHubCredentialOperations.html
:apidocs-certificates: {apidocs-home}?org/springframework/credhub/core/certificate/CredHubCertificateOperations.html
:apidocs-permissions: {apidocs-home}?org/springframework/credhub/core/permission/CredHubPermissionOperations.html

5
spring-credhub-docs/src/docs/asciidoc/reactive-operations.adoc
View File

@@ -1,3 +1,4 @@
:examples-dir: ../../src/test/java/com/example/credhub/
:apidocs-reactive-credentials: {apidocs-home}?org/springframework/credhub/core/credential/ReactiveCredHubCredentialOperations.html
:apidocs-reactive-certificates: {apidocs-home}?org/springframework/credhub/core/certificate/ReactiveCredHubCertificateOperations.html
:apidocs-reactive-permissions: {apidocs-home}?org/springframework/credhub/core/permission/ReactiveCredHubPermissionOperations.html
@@ -67,8 +68,8 @@ The following table shows the mapping between the CredHub API and the appropriat
| {apidocs-reactive-interpolation}[ReactiveCredHubInterpolationOperations]
| {credhub-api-info}[CredHub Information API]
| {apidocs-reactive-info}[CredHubInfoOperations]
|=======
| {apidocs-reactive-info}[ReactiveCredHubInfoOperations]
|===
=== ReactiveCredHubOperations Auto-configuration