mirror of
https://github.com/hashicorp/vault.git
synced 2026-05-05 04:16:31 +02:00
Rename database plugins for SEO (#3156)
When we "nest" like this, it's important to use a common suffix, "Database Secret Backend" in this case, so that the SEO minions can properly group search results for end users.
This commit is contained in:
Seth Vargo
Vishal Nayak
parent
4bbaaac6b2
commit
24c4c0c9c2
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "Cassandra Database Plugin"
|
||||
page_title: "Cassandra Database Plugin - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-cassandra"
|
||||
description: |-
|
||||
The Cassandra plugin for Vault's Database backend generates database credentials to access Cassandra.
|
||||
@ -21,7 +21,7 @@ information about setting up the Database Backend.
|
||||
|
||||
After the Database Backend is mounted you can configure a cassandra connection
|
||||
by specifying this plugin as the `"plugin_name"` argument. Here is an example
|
||||
cassandra configuration:
|
||||
cassandra configuration:
|
||||
|
||||
```
|
||||
$ vault write database/config/cassandra \
|
||||
@ -59,4 +59,3 @@ plugin API](/api/secret/databases/cassandra.html) page.
|
||||
|
||||
For more information on the Database secret backend's HTTP API please see the [Database secret
|
||||
backend API](/api/secret/databases/index.html) page.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "Custom Database Plugins"
|
||||
page_title: "Custom Database Plugins - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-custom"
|
||||
description: |-
|
||||
Creating custom database plugins for Vault's Database backend to generate credentials for a database.
|
||||
@ -12,7 +12,7 @@ The Database backend allows new functionality to be added through a plugin
|
||||
interface without needing to modify vault's core code. This allows you write
|
||||
your own code to generate credentials in any database you wish. It also allows
|
||||
databases that require dynamically linked libraries to be used as plugins while
|
||||
keeping Vault itself statically linked.
|
||||
keeping Vault itself statically linked.
|
||||
|
||||
~> **Advanced topic!** Plugin development is a highly advanced
|
||||
topic in Vault, and is not required knowledge for day-to-day usage.
|
||||
@ -45,10 +45,10 @@ statements to the plugin on function call. The struct is defined as:
|
||||
|
||||
```go
|
||||
type Statements struct {
|
||||
CreationStatements string
|
||||
CreationStatements string
|
||||
RevocationStatements string
|
||||
RollbackStatements string
|
||||
RenewStatements string
|
||||
RollbackStatements string
|
||||
RenewStatements string
|
||||
}
|
||||
```
|
||||
|
||||
@ -89,16 +89,16 @@ config wont be used once the plugin unwraps its own TLS cert and key.
|
||||
|
||||
The above main package, once built, will supply you with a binary of your
|
||||
plugin. We also recommend if you are planning on distributing your plugin to
|
||||
build with [gox](https://github.com/mitchellh/gox) for cross platform builds.
|
||||
build with [gox](https://github.com/mitchellh/gox) for cross platform builds.
|
||||
|
||||
To use your plugin with the Database backend you need to place the binary in the
|
||||
plugin directory as specified in the [plugin internals](/docs/internals/plugins.html) docs.
|
||||
plugin directory as specified in the [plugin internals](/docs/internals/plugins.html) docs.
|
||||
|
||||
You should now be able to register your plugin into the vault catalog. To do
|
||||
this your token will need sudo permissions.
|
||||
this your token will need sudo permissions.
|
||||
|
||||
```
|
||||
$ vault write sys/plugins/catalog/myplugin-database-plugin \
|
||||
$ vault write sys/plugins/catalog/myplugin-database-plugin \
|
||||
sha_256=<expected SHA256 Hex value of the plugin binary> \
|
||||
command="myplugin"
|
||||
Success! Data written to: sys/plugins/catalog/myplugin-database-plugin
|
||||
@ -115,7 +115,3 @@ $ vault write database/config/myplugin \
|
||||
The following warnings were returned from the Vault server:
|
||||
* Read access to this endpoint should be controlled via ACLs as it will return the connection details as is, including passwords, if any.
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "HANA Database Plugin"
|
||||
page_title: "HANA Database Plugin - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-HANA"
|
||||
description: |-
|
||||
The HANA plugin for Vault's Database backend generates database credentials to access SAP HANA Database.
|
||||
@ -57,4 +57,3 @@ plugin API](/api/secret/databases/HANA.html) page.
|
||||
|
||||
For more information on the Database secret backend's HTTP API please see the [Database secret
|
||||
backend API](/api/secret/databases/index.html) page.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "Databases"
|
||||
page_title: "Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases"
|
||||
description: |-
|
||||
Top page for database secret backend information
|
||||
@ -100,4 +100,3 @@ plugin](/docs/secrets/databases/custom.html) for more information.
|
||||
|
||||
The Database secret backend has a full HTTP API. Please see the [Database secret
|
||||
backend API](/api/secret/databases/index.html) for more details.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "MongoDB Database Plugin"
|
||||
page_title: "MongoDB Database Plugin - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-mongodb"
|
||||
description: |-
|
||||
The MongoDB plugin for Vault's Database backend generates database credentials to access MongoDB.
|
||||
@ -21,13 +21,13 @@ information about setting up the Database Backend.
|
||||
|
||||
After the Database Backend is mounted you can configure a MongoDB connection
|
||||
by specifying this plugin as the `"plugin_name"` argument. Here is an example
|
||||
MongoDB configuration:
|
||||
MongoDB configuration:
|
||||
|
||||
```
|
||||
$ vault write database/config/mongodb \
|
||||
plugin_name=mongodb-database-plugin \
|
||||
allowed_roles="readonly" \
|
||||
connection_url="mongodb://admin:Password!@mongodb.acme.com:27017/admin?ssl=true"
|
||||
connection_url="mongodb://admin:Password!@mongodb.acme.com:27017/admin?ssl=true"
|
||||
|
||||
The following warnings were returned from the Vault server:
|
||||
* Read access to this endpoint should be controlled via ACLs as it will return the connection details as is, including passwords, if any.
|
||||
@ -55,4 +55,3 @@ plugin API](/api/secret/databases/mongodb.html) page.
|
||||
|
||||
For more information on the Database secret backend's HTTP API please see the [Database secret
|
||||
backend API](/api/secret/databases/index.html) page.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "MSSQL Database Plugin"
|
||||
page_title: "MSSQL Database Plugin - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-mssql"
|
||||
description: |-
|
||||
The MSSQL plugin for Vault's Database backend generates database credentials to access Microsoft SQL Server.
|
||||
@ -21,7 +21,7 @@ information about setting up the Database Backend.
|
||||
|
||||
After the Database Backend is mounted you can configure a MSSQL connection
|
||||
by specifying this plugin as the `"plugin_name"` argument. Here is an example
|
||||
configuration:
|
||||
configuration:
|
||||
|
||||
```
|
||||
$ vault write database/config/mssql \
|
||||
@ -43,7 +43,7 @@ $ vault write database/roles/readonly \
|
||||
GRANT SELECT ON SCHEMA::dbo TO [{{name}}];" \
|
||||
default_ttl="1h" \
|
||||
max_ttl="24h"
|
||||
|
||||
|
||||
Success! Data written to: database/roles/readonly
|
||||
```
|
||||
|
||||
@ -57,4 +57,3 @@ plugin API](/api/secret/databases/mssql.html) page.
|
||||
|
||||
For more information on the Database secret backend's HTTP API please see the [Database secret
|
||||
backend API](/api/secret/databases/index.html) page.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "MySQL/MariaDB Database Plugin"
|
||||
page_title: "MySQL/MariaDB Database Plugin - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-mysql-maria"
|
||||
description: |-
|
||||
The MySQL/MariaDB plugin for Vault's Database backend generates database credentials to access MySQL and MariaDB servers.
|
||||
@ -19,7 +19,7 @@ This plugin has a few different instances built into vault, each instance is for
|
||||
a slightly different MySQL driver. The only difference between these plugins is
|
||||
the length of usernames generated by the plugin as different versions of mysql
|
||||
accept different lengths. The available plugins are:
|
||||
|
||||
|
||||
- mysql-database-plugin
|
||||
- mysql-aurora-database-plugin
|
||||
- mysql-rds-database-plugin
|
||||
@ -32,7 +32,7 @@ information about setting up the Database Backend.
|
||||
|
||||
After the Database Backend is mounted you can configure a MySQL connection
|
||||
by specifying this plugin as the `"plugin_name"` argument. Here is an example
|
||||
configuration:
|
||||
configuration:
|
||||
|
||||
```
|
||||
$ vault write database/config/mysql \
|
||||
@ -94,4 +94,4 @@ $ vault write database/roles/readonly \
|
||||
creation_statements="Q1JFQVRFIFVTRVIgJ3t7bmFtZX19J0AnJScgSURFTlRJRklFRCBCWSAne3twYXNzd29yZH19JzsgR1JBTlQgU0VMRUNUIE9OIGBmb29hcHBcXyVgLiogVE8gJ3t7bmFtZX19J0AnJSc7" \
|
||||
default_ttl="1h" \
|
||||
max_ttl="24h"
|
||||
```
|
||||
```
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "PostgreSQL Database Plugin"
|
||||
page_title: "PostgreSQL Database Plugin - Database Secret Backend"
|
||||
sidebar_current: "docs-secrets-databases-postgresql"
|
||||
description: |-
|
||||
The PostgreSQL plugin for Vault's Database backend generates database credentials to access PostgreSQL.
|
||||
@ -21,7 +21,7 @@ information about setting up the Database Backend.
|
||||
|
||||
After the Database Backend is mounted you can configure a PostgreSQL connection
|
||||
by specifying this plugin as the `"plugin_name"` argument. Here is an example
|
||||
configuration:
|
||||
configuration:
|
||||
|
||||
```
|
||||
$ vault write database/config/postgresql \
|
||||
@ -57,4 +57,3 @@ plugin API](/api/secret/databases/postgresql.html) page.
|
||||
|
||||
For more information on the Database secret backend's HTTP API please see the [Database secret
|
||||
backend API](/api/secret/databases/index.html) page.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user