Skip to content

Commit

Permalink
chore: remove long gone KongCredentials from 2.x docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneutt committed Aug 6, 2021
1 parent 38d47ce commit d9112d5
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ The following CRDs allow users to declaratively configure all aspects of Kong:
- [**KongConsumer**](#kongconsumer)
- [**TCPIngress**](#tcpingress)
- [**UDPIngress**](#udpingress)
- [**KongCredential (Deprecated)**](#kongcredential-deprecated)

## KongIngress

Expand Down Expand Up @@ -127,17 +126,6 @@ This is useful for services such as DNS servers, Game Servers,
VPN software and a variety of other applications.

[udp]:https://datatracker.ietf.org/doc/html/rfc768

## KongCredential (Deprecated)

Once a `KongConsumer` resource is created,
credentials associated with the `Consumer` can be provisioned inside Kong
using KongCredential custom resource.

This Custom Resource has been deprecated and will be removed in a future
release.
Instead, please use secret-based credentials.

[k8s-crd]: https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/
[kong-consumer]: /gateway-oss/latest/admin-api/#consumer-object
[kong-plugin]: /gateway-oss/latest/admin-api/#plugin-object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ on the following Kubernetes resources:
- Ingress
- KongPlugins
- KongConsumers
- KongCredentials
- KongIngress

By default, the controller listens for events and above resources across
Expand Down
2 changes: 1 addition & 1 deletion app/kubernetes-ingress-controller/2.0.x/guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ the {{site.kic_product_name}}:
- [Using KongIngress resource](/kubernetes-ingress-controller/{{page.kong_version}}/guides/using-kongingress-resource)
This guide explains how the KongIngress resource can be used to change Kong
specific settings like load-balancing, health-checking and proxy behaviour.
- [Using KongConsumer and KongCredential resources](/kubernetes-ingress-controller/{{page.kong_version}}/guides/using-consumer-credential-resource)
- [Using KongConsumer resources](/kubernetes-ingress-controller/{{page.kong_version}}/guides/using-consumer-credential-resource)
This guide walks through how Kubernetes native declarative configuration
can be used to dynamically provision credentials for authentication purposes
in the Ingress layer.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@ following custom resources as well:

- KongPlugin: To configure (global) plugins only in one of the Kong clusters.
- KongConsumer: To create different consumers in different Kong clusters.
- KongCredential: To create associated credentials for consumers.

### konghq.com/plugins

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,9 @@ metadata:
annotations:
kubernetes.io/ingress.class: kong
username: team-X
credentials:
- secretRef1
- secretRef2
```

When this resource is created, a corresponding consumer entity will be
Expand All @@ -401,41 +404,7 @@ KongConsumers from all namespaces are combined into a single Kong
configuration, and no KongConsumers with the same `kubernetes.io/ingress.class`
may share the same `username` or `custom_id` value.

## KongCredential (Deprecated)

This custom resource can be used to configure a consumer specific
entities in Kong.
The resource reference the KongConsumer resource via the `consumerRef` key.

The validation of the config object is left up to the user.

```yaml
apiVersion: configuration.konghq.com/v1
kind: KongCredential
metadata:
name: credential-team-x
consumerRef: consumer-team-x
type: key-auth
config:
key: 62eb165c070a41d5c1b58d9d3d725ca1
```

The following credential types can be provisioned using the KongCredential
resource:

- `key-auth` for [Key authentication](https://docs.konghq.com/plugins/key-authentication/)
- `basic-auth` for [Basic authenticaiton](https://docs.konghq.com/plugins/basic-authentication/)
- `hmac-auth` for [HMAC authentication](http://docs.konghq.com/plugins/hmac-authentication/)
- `jwt` for [JWT based authentication](http://docs.konghq.com/plugins/jwt/)
- `oauth2` for [Oauth2 Client credentials](https://docs.konghq.com/hub/kong-inc/oauth2/)
- `acl` for [ACL group associations](https://docs.konghq.com/hub/kong-inc/acl/)

Please ensure that all fields related to the credential in Kong
are present in the definition of KongCredential's `config` section.

Please refer to the
[using the Kong Consumer and Credential resource](/kubernetes-ingress-controller/{{page.kong_version}}/guides/using-consumer-credential-resource)
guide for details on how to use this resource.
For help configuring credentials for the `KongConsumer` Please refer to the [using the Kong Consumer and Credential resource](/kubernetes-ingress-controller/{{page.kong_version}}/guides/using-consumer-credential-resource) guide.

[k8s-crd]: https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/
[kong-consumer]: /gateway-oss/latest/admin-api/#consumer-object
Expand Down

0 comments on commit d9112d5

Please sign in to comment.