Skip to content

Commit

Permalink
Updates for KES release on 2024-02-29 (#54)
Browse files Browse the repository at this point in the history
* Updates for KES release 2024-02-29T08-12-28Z

- Adds info about KES Grafana dashboard
- Adds info about new HMAC API endpoint
- Removes references to "enclave" throughout and two `rm` commands
- Updates info about downgrading after this version

Closes #49

* Adds weights to pages to give order to the left nav.
  • Loading branch information
djwfyi authored Apr 5, 2024
1 parent db8e7d5 commit 02c2779
Show file tree
Hide file tree
Showing 42 changed files with 82 additions and 362 deletions.
3 changes: 0 additions & 3 deletions content/_includes/params/enclave.md

This file was deleted.

1 change: 0 additions & 1 deletion content/_includes/server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,6 @@ log:
# "time": "2006-01-02T15:04:05Z07:00",
# "request": {
# "ip": "87.149.99.199",
# "enclave": "default",
# "path": "/v1/key/create/my-app-key",
# "identity": "4067503933d4a78358f908a2df7ec14e554c612acf8a9d1aa29b7da4aa018ec9",
# },
Expand Down
2 changes: 1 addition & 1 deletion content/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ docker pull minio/kes
{{< /tab >}}

{{< tab "Homebrew" >}}
MacOS users can use [Homebrew](https://brew.sh/) to install KES:
macOS users can use [Homebrew](https://brew.sh/) to install KES:

```sh {.copy}
brew install minio/stable/kes
Expand Down
20 changes: 0 additions & 20 deletions content/cli/kes-enclave/_index.md

This file was deleted.

46 changes: 0 additions & 46 deletions content/cli/kes-enclave/create.md

This file was deleted.

50 changes: 0 additions & 50 deletions content/cli/kes-enclave/info.md

This file was deleted.

39 changes: 0 additions & 39 deletions content/cli/kes-enclave/rm.md

This file was deleted.

1 change: 0 additions & 1 deletion content/cli/kes-identity/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ This page provides reference information for the `kes identity` commands.
|[`ls`]({{< relref "/cli/kes-identity/ls" >}}) |List KES identities |
|[`new`]({{< relref "/cli/kes-identity/new" >}}) |Create a KES identity |
|[`of`]({{< relref "/cli/kes-identity/of" >}}) |Compute a KES identity from a certificate |
|[`rm`]({{< relref "/cli/kes-identity/rm" >}}) |Delete a KES identity |


## Related Content
Expand Down
9 changes: 3 additions & 6 deletions content/cli/kes-identity/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Role Admin
```sh
kes identity info \
[--color <string>] \
[--enclave, -e <name>] \
[<identity>] \
[--insecure, -k] \
[--json]
Expand All @@ -35,10 +34,6 @@ kes identity info \

{{< include "_includes/params/color.md" >}}

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `identity`

_Optional_
Expand All @@ -55,12 +50,14 @@ The UUID of a specific identity to retrieve information about.

## Examples

The following command displays the identity information for the enclave named `tenant-1`.
The following command displays the identity information for the kes server.

```sh {.copy}
kes identity info`
```

The following command displays the identity of the provided key.

```sh {.copy}
kes identity info 3ecfcdf38fcbe141ae26a1030f81e96b753365a46760ae6b578698a97c59fd22
```
5 changes: 0 additions & 5 deletions content/cli/kes-identity/ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ The `kes identity ls` command does not return admin identities.
```sh
kes identity ls \
[--color <string>] \
[--enclave, -e <string>] \
[--insecure, -k] \
[--json] \
[pattern]
Expand All @@ -32,10 +31,6 @@ kes identity ls \

{{< include "_includes/params/color.md" >}}

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
33 changes: 0 additions & 33 deletions content/cli/kes-identity/rm.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/cli/kes-key/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ KES *never* returns the generated secret to clients.
```sh
kes key create \
<name> \
[--enclave, -e <name>] \
[--insecure, -k]
```

Expand All @@ -28,10 +27,6 @@ kes key create \

You may add multiple names to a single command to generate multiple keys.

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
5 changes: 0 additions & 5 deletions content/cli/kes-key/decrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ kes key decrypt \
<name> \
<ciphertext> \
[<context>] \
[--enclave, -e <name>] \
[--insecure,-k]
```

Expand All @@ -47,10 +46,6 @@ The context value to scope the request for a data encryption key.

You create contexts in the `kubeconfig` file of a Kubernetes deployment to define a set of cluster, namespace, and user configuration to use.

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
5 changes: 0 additions & 5 deletions content/cli/kes-key/dek.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Avoid storing the plaintext value of a DEK on disk, as it allows decryption of d
key key dek
<name> \
[<context>] \
[--enclave, -e <name>] \
[--insecure, -k]
```

Expand All @@ -48,10 +47,6 @@ The context value to scope the request for a data encryption key.

You create contexts in the `kubeconfig` file of a Kubernetes deployment to define a set of cluster, namespace, and user configuration to use.

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
5 changes: 0 additions & 5 deletions content/cli/kes-key/encrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Avoid storing the plaintext on disk, as it allows decryption of data without req
kes key encrypt \
<name> \
<message> \
[--enclave, e <name>] \
[--insecure,-k]
```

Expand All @@ -38,10 +37,6 @@ _Required_

The string to encrypt.

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
5 changes: 0 additions & 5 deletions content/cli/kes-key/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Import a cryptographic key.
kes key import \
<name> \
<key> \
[--enclave, -e <name>] \
[--insecure, -k]
```

Expand All @@ -32,10 +31,6 @@ _Required_

Key to use to decrypt the import file.

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
5 changes: 0 additions & 5 deletions content/cli/kes-key/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Created By 3ecfcdf38fcbe141ae26a1030f81e96b753365a46760ae6b578698a97c59fd22
kes key info \
<name> \
[--color <string>] \
[--enclave, -e] \
[--insecure, -k] \
[--json]
```
Expand All @@ -40,10 +39,6 @@ kes key info \

{{< include "_includes/params/color.md" >}}

### `--enclave, -e`

{{< include "_includes/params/enclave.md" >}}

### `--insecure, -k`

{{< include "_includes/params/insecure.md" >}}
Expand Down
Loading

0 comments on commit 02c2779

Please sign in to comment.