Skip to content

Commit

Permalink
Navbar updates (#4286)
Browse files Browse the repository at this point in the history
* nav bar

* title case

* Re-apply changes from release branch

* Fix broken rebase

* Move get-started to index for breadcrumbs

* Move /install/ out of /kong-production/

* Move /licenses/ out of /kong-production/

* Move upgrade instructions under /upgrade/ folder

* Rename /other/ to /pluginserver/ in Plugin Development

* Rename use-cases -> index for Kong Plugins -> Auth

* Remove duplicate prefix, move graphql-quickstart to graphql

* Clean up Admin API nav

* Reference section cleanup

* Rename Stages of software availability to Stability

* Remove Rate Limit Library page

* DOCU-2415: updates Services and Routes getting started section (#4304)

* DOCU-2415: Updates Services and Routes get-started section

* Apply review feedback

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Fix Docker install instructions after rename

* Flatten Admin API navigation

* Move example files out of /admin-api/

* placeholder

* Move Securing the Admin API to Running Kong

* Move Understanding Kong guides to the relevant locations

* Split Key Concepts / How Kong works

* Manage Kong with decK is a Key Concept

* remove deck guide

* fix merge conflicts

* parity with spreadhsheet

* PR that contains cannonical URLS

* placeholder

* keyring and data encryption docs

* Rate limiting section restructured

* breadcrumb acronyms

* fix typo in header

* Update app/_data/docs_nav_gateway_3.0.x.yml

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* upgrade section top level directory move

* working but no redirects

* fix slash

* helm doc recommit

* Fix Rubocop for Alias generator

Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Rick Spurgeon <rspurgeon@users.noreply.github.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
  • Loading branch information
5 people authored Aug 29, 2022
1 parent 437b345 commit a3d1259
Show file tree
Hide file tree
Showing 109 changed files with 2,480 additions and 944 deletions.
402 changes: 195 additions & 207 deletions app/_data/docs_nav_gateway_3.0.x.yml

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions app/_plugins/filters/titleize_filter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
ActiveSupport::Inflector.inflections do |inflect|
inflect.acronym 'API'
inflect.acronym 'mTLS'
inflect.acronym 'PDK'
inflect.acronym 'OIDC'
end

module Jekyll
Expand Down
8 changes: 4 additions & 4 deletions app/_plugins/generators/alias_generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ module Jekyll
class AliasGenerator < Generator
priority :lowest

def generate(site) # rubocop:disable Metrics/AbcSize
def generate(site) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@redirects = []

# Generate redirect_to from frontmatter redirects
Expand All @@ -54,9 +54,9 @@ def generate(site) # rubocop:disable Metrics/AbcSize
end

def generate_moved_aliases(moved_pages)
moved_pages.each do |k,v|
k = k.sub("/VERSION/", "/latest/")
v = v.sub("/VERSION/", "/latest/")
moved_pages.each do |k, v|
k = k.sub('/VERSION/', '/latest/')
v = v.sub('/VERSION/', '/latest/')
@redirects.push("#{k}\t#{v}")
end
end
Expand Down
13 changes: 13 additions & 0 deletions app/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -700,3 +700,16 @@
/introduction /
/enterprise/ /gateway/
/gateway-oss/ /gateway/



# 3.0

/gateway/2.8.x/install-and-run/ /gateway/latest/install-and-run/os-support
/gateway/2.8.x/install-and-run/centos/ /gateway/latest/install-and-run/os-support
/gateway/2.8.x/get-started/quickstart/ /gateway/latest/get-started/
/gateway/2.8.x/get-started/quickstart/configuring-a-service/ /gateway/latest/get-started/services-and-routes/
/gateway/2.8.x/get-started/quickstart/configuring-a-grpc-service/ /gateway/latest/get-started/ratelimiting/
/gateway/2.8.x/get-started/quickstart/enabling-plugins/ /gateway/latest/key-concepts/plugins/
/gateway/2.8.x/get-started/quickstart/adding-consumers/ /gateway/latest/get-started/key-authentication
/gateway/2.8.x/admin-api/rbac/examples/ /gateway/latest/admin-api/rbac/reference/
184 changes: 182 additions & 2 deletions app/moved_urls.yml

Large diffs are not rendered by default.

203 changes: 203 additions & 0 deletions src/gateway/admin-api/db-encryption.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
---
title: Keyring and Data Encryption Reference
badge: enterprise
---

## View Keyring
**Endpoint**

<div class="endpoint get">/keyring</div>

**Response**

```
HTTP 200 OK
```

```json
{
"active": "RfsDJ2Ol",
"ids": [
"RfsDJ2Ol",
"xSD219lH"
]
}

```

## View Active Key
**Endpoint**

<div class="endpoint get">/keyring/active</div>

**Response**

```
HTTP 200 OK
```

```json
{
"id": "RfsDJ2Ol"
}

```

## Export Keyring

*This endpoint is only available with the `cluster` keyring strategy.*

*The endpoint requires that the `keyring_public_key` and `keyring_private_key` Kong configuration values are defined.*

**Endpoint**

<div class="endpoint post">/keyring/export</div>

**Response**

```
HTTP 200 OK
```

```json
{
"data": "<base64>..."
}
```

## Import Exported Keyring

*This endpoint is only available with the `cluster` keyring strategy.*

*The endpoint requires that the `keyring_public_key` and `keyring_private_key` Kong configuration values are defined.*

**Endpoint**

<div class="endpoint post">/keyring/import</div>

**Request Body**

| Attribute | Description |
| --------- | ----------- |
| `data` | Base64-encoded keyring export material. |


**Response**

```
HTTP 201 Created
```

## Import Key

*This endpoint is only available with the `cluster` keyring strategy.*

*The endpoint requires that the `keyring_public_key` and `keyring_private_key` Kong configuration values are defined.*

**Endpoint**

<div class="endpoint post">/keyring/import/raw</div>

**Request Body**

| Attribute | Description |
| --------- | ----------- |
| `id` | 8-byte key identifier. |
| `data` | Base64-encoded keyring export material. |


**Response**

```
HTTP 201 Created
```

## Recover Keyring from Database

*This endpoint is only available with the `cluster` keyring strategy.*

*The endpoint requires that the `keyring_recovery_public_key` Kong configuration value is defined.*

**Endpoint**

<div class="endpoint post">/keyring/recover</div>

**Request Body**

| Attribute | Description |
| --------- | ----------- |
| `recovery_private_key` | The content of the private key. |

**Response**

```
HTTP 200 OK
```

```json
{
"message": "successfully recovered 1 keys",
"recovered": [
"RfsDJ2Ol"
],
"not_recovered": [
"xSD219lH"
]
}
```

## Generate New Key

*This endpoint is only available with the `cluster` keyring strategy.*

**Endpoint**

<div class="endpoint post">/keyring/generate</div>

**Response**

```
HTTP 201 Created
```

```json
{
"id": "500pIquV",
"key": "3I23Ben5m7qKcCA/PK7rnsNeD3kI4IPtA6ki7YjAgKA="
}
```

## Remove Key from Keyring

*This endpoint is only available with the `cluster` keyring strategy.*

**Endpoint**

<div class="endpoint post">/keyring/remove</div>

**Request Body**

| Attribute | Description |
| --------- | ----------- |
| `key` | 8-byte key identifier. |


**Response**

```
HTTP 204 No Content
```

## Sync Keyring with Vault Endpoint

*This endpoint is only available with the `vault` keyring strategy.*

**Endpoint**

<div class="endpoint post">/keyring/vault/sync</div>

**Response**

```
HTTP 204 No Content
```
2 changes: 1 addition & 1 deletion src/gateway/admin-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4186,7 +4186,7 @@ HTTP 200 OK

---

## Vaults Beta Entity
## Vaults Entity

Vault entities are used to configure different Vault connectors. Examples of
Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager.
Expand Down
File renamed without changes.
Loading

0 comments on commit a3d1259

Please sign in to comment.