From 370ec356fc5f4b04e178f1e308e268cdfe55a484 Mon Sep 17 00:00:00 2001 From: Jim Kalafut Date: Wed, 17 Nov 2021 17:03:26 -0800 Subject: [PATCH] Unhide or remove docs sidebar elements A few sidebar elements are hidden for unknown reasons. If we have a reason to keep them hidden (vs deleting the element and associated docs), maybe we could add `"_comment":"Hidden because ..."` to them. A few other elements were definitely obsolete so I've removed them. --- website/content/docs/secrets/cassandra.mdx | 103 --------------------- website/content/docs/vs.mdx | 16 ---- website/data/docs-nav-data.json | 24 +---- 3 files changed, 3 insertions(+), 140 deletions(-) delete mode 100644 website/content/docs/secrets/cassandra.mdx delete mode 100644 website/content/docs/vs.mdx diff --git a/website/content/docs/secrets/cassandra.mdx b/website/content/docs/secrets/cassandra.mdx deleted file mode 100644 index 7fffd5c9514..00000000000 --- a/website/content/docs/secrets/cassandra.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -layout: docs -page_title: Cassandra - Secrets Engines -description: >- - The Cassandra secrets engine for Vault generates database credentials to - access Cassandra. ---- - -# Cassandra Secrets Engine - -~> **Deprecation Note:** This secrets engine is deprecated in favor of the -combined databases secrets engine added in v0.7.1. See the documentation for -the new implementation of this secrets engine at -[Cassandra database plugin](/docs/secrets/databases/cassandra). - -The Cassandra secrets engine for Vault generates database credentials -dynamically based on configured roles. This means that services that need -to access a database no longer need to hardcode credentials: they can request -them from Vault, and use Vault's leasing mechanism to more easily roll keys. - -Additionally, it introduces a new ability: with every service accessing -the database with unique credentials, it makes auditing much easier when -questionable data access is discovered: you can track it down to the specific -instance of a service based on the Cassandra username. - -This page will show a quick start for this secrets engine. For detailed documentation -on every path, use `vault path-help` after mounting the secrets engine. - -## Quick Start - -The first step to using the Cassandra secrets engine is to mount it. Unlike the -`kv` secrets engine, the `cassandra` secrets engine is not mounted by default. - -```shell-session -$ vault secrets enable cassandra -Success! Enabled the cassandra secrets engine at: cassandra/ -``` - -Next, Vault must be configured to connect to Cassandra. This is done by -writing one or more hosts, a username, and a password: - -```shell-session -$ vault write cassandra/config/connection \ - hosts=localhost \ - username=cassandra \ - password=cassandra -``` - -In this case, we've configured Vault with the user "cassandra" and password "cassandra", -It is important that the Vault user is a superuser, in order to manage other user accounts. - -The next step is to configure a role. A role is a logical name that maps -to a policy used to generated those credentials. For example, lets create -a "readonly" role: - -```shell-session -$ vault write cassandra/roles/readonly \ - creation_cql="CREATE USER '{{username}}' WITH PASSWORD '{{password}}' NOSUPERUSER; \ - GRANT SELECT ON ALL KEYSPACES TO {{username}};" -Success! Data written to: cassandra/roles/readonly -``` - -By writing to the `roles/readonly` path we are defining the `readonly` role. -This role will be created by evaluating the given `creation_cql` statements. By -default, the `{{username}}` and `{{password}}` fields will be populated by -Vault with dynamically generated values. This CQL statement is creating -the named user, and then granting it `SELECT` or read-only privileges -to keyspaces. More complex `GRANT` queries can be used to -customize the privileges of the role. See the [CQL Reference Manual](https://docs.datastax.com/en/cql/3.1/cql/cql_reference/grant_r.html) -for more information. - -To generate a new set of credentials, we simply read from that role: -Vault is now configured to create and manage credentials for Cassandra! - -```shell-session -$ vault read cassandra/creds/readonly -Key Value ---- ----- -lease_id cassandra/creds/test/7a23e890-3a26-531d-529b-92d18d1fa63f -lease_duration 3600 -lease_renewable true -password dfa80eea-ccbe-b228-ebf7-e2f62b245e71 -username vault-root-1434647667-9313 -``` - -By reading from the `creds/readonly` path, Vault has generated a new -set of credentials using the `readonly` role configuration. Here we -see the dynamically generated username and password, along with a one -hour lease. - -Using ACLs, it is possible to restrict using the `cassandra` secrets engine such -that trusted operators can manage the role definitions, and both -users and applications are restricted in the credentials they are -allowed to read. - -If you get stuck at any time, simply run `vault path-help cassandra` or with a -subpath for interactive help output. - -## API - -The Cassandra secrets engine has a full HTTP API. Please see the -[Cassandra secrets engine API](/api/secret/cassandra) for more -details. diff --git a/website/content/docs/vs.mdx b/website/content/docs/vs.mdx deleted file mode 100644 index 0b0d192e556..00000000000 --- a/website/content/docs/vs.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: docs -page_title: Versus Other Software ---- - -# Versus Other Software - -Although we used to publish information about Vault versus other software, we -no longer do. Partly this is because the information grew exceedingly -out-of-date as Vault gained new functionality and features. More importantly, -just as we like to present information about Vault and its capabilities in the -ways that we prefer, we felt it wasn't appropriate to describe the capabilities -of other projects or products in ways other than their own terms. As a result, -we have decided to remove this section; please consult other projects or -products for information on how they might meet your needs, and use our -documentation or product pages to understand how Vault might meet your needs. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 743b59199e3..f9e0e78ad43 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -283,8 +283,7 @@ }, { "title": "Alicloud OSS", - "path": "configuration/storage/alicloudoss", - "hidden": true + "path": "configuration/storage/alicloudoss" }, { "title": "Azure", @@ -455,11 +454,6 @@ "title": "delete", "path": "commands/delete" }, - { - "title": "help", - "path": "commands/help", - "hidden": true - }, { "title": "kv", "routes": [ @@ -518,8 +512,7 @@ }, { "title": "lookup", - "path": "commands/lease/lookup", - "hidden": true + "path": "commands/lease/lookup" }, { "title": "renew", @@ -915,11 +908,6 @@ "title": "Azure", "path": "secrets/azure" }, - { - "title": "Cassandra", - "path": "secrets/cassandra", - "hidden": true - }, { "title": "Consul", "path": "secrets/consul" @@ -1119,8 +1107,7 @@ }, { "title": "FF3-1 Tweak Usage", - "path": "secrets/transform/ff3-tweak-details", - "hidden": true + "path": "secrets/transform/ff3-tweak-details" }, { "title": "Tokenization Transform ENTERPRISE", @@ -1476,11 +1463,6 @@ { "divider": true }, - { - "title": "Versus Other Software", - "path": "vs", - "hidden": true - }, { "title": "Upgrade Guides", "routes": [