luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Update to CRD docs (#8956) 

* Update to CRD docs

* Update website/pages/docs/k8s/crds.mdx

* Modify proxy default and service default protocols

Carry over from previous PR that I forgot to submit a review/suggestion to, TCP and HTTP are not valid protocols for Proxy Defaults and Service Defaults

kubectl apply -f sdefault.yml
Error from server: error when creating "sdefault.yml": admission webhook "mutate-servicedefaults.consul.hashicorp.com" denied the request: servicedefaults.consul.hashicorp.com "your-service-name" is invalid: spec.expose.paths[0].protocol: Invalid value: "tcp": must be one of "http", "http2"


kubectl apply -f sdefault.yml
Error from server: error when creating "sdefault.yml": admission webhook "mutate-servicedefaults.consul.hashicorp.com" denied the request: servicedefaults.consul.hashicorp.com "your-service-name" is invalid: spec.expose.paths[0].protocol: Invalid value: "tcp": must be one of "http", "http2"

Co-authored-by: David Yu <dyu@hashicorp.com>
This commit is contained in:
Luke Kysow 2020-10-15 10:35:26 -07:00 committed by GitHub
parent 718380cebe
commit b4897cca6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
website/pages/docs/k8s/crds.mdx
View File

@ -81,11 +81,11 @@ instructions.
## Usage ## Usage
Once installed, we can use `kubectl` to create and manage Consul's configuration entries. Once installed, you can use `kubectl` to create and manage Consul's configuration entries.
### Create ### Create
We can create configuration entries via `kubectl apply`. You can create configuration entries via `kubectl apply`.
```shell-session ```shell-session
$ cat <<EOF | kubectl apply -f - $ cat <<EOF | kubectl apply -f -
@ -104,7 +104,7 @@ See [Specifications](#specifications) for detailed schema documentation.
### Get ### Get
We can use `kubectl get [kind] [name]` to get the status of the configuration entry: You can use `kubectl get [kind] [name]` to get the status of the configuration entry:
```shell-session ```shell-session
$ kubectl get servicedefaults foo $ kubectl get servicedefaults foo
@ -117,7 +117,7 @@ in Consul.
### Describe ### Describe
We can use `kubectl describe [kind] [name]` to investigate the status of the You can use `kubectl describe [kind] [name]` to investigate the status of the
configuration entry. If `SYNCED` is false, the status will contain the reason configuration entry. If `SYNCED` is false, the status will contain the reason
why. why.
@ -132,7 +132,7 @@ Status:
### Edit ### Edit
We can use `kubectl edit [kind] [name]` to edit the configuration entry: You can use `kubectl edit [kind] [name]` to edit the configuration entry:
```shell ```shell
$ kubectl edit servicedefaults foo $ kubectl edit servicedefaults foo
@ -140,7 +140,7 @@ $ kubectl edit servicedefaults foo
servicedefaults.consul.hashicorp.com/foo edited servicedefaults.consul.hashicorp.com/foo edited
``` ```
We can then use `kubectl get` to ensure the change was synced to Consul: You can then use `kubectl get` to ensure the change was synced to Consul:
```shell-session ```shell-session
$ kubectl get servicedefaults foo $ kubectl get servicedefaults foo
@ -150,14 +150,14 @@ foo True
### Delete ### Delete
We can use `kubectl delete [kind] [name]` to delete the configuration entry: You can use `kubectl delete [kind] [name]` to delete the configuration entry:
```shell-session ```shell-session
$ kubectl delete servicedefaults foo $ kubectl delete servicedefaults foo
servicedefaults.consul.hashicorp.com "foo" deleted servicedefaults.consul.hashicorp.com "foo" deleted
``` ```
We can then use `kubectl get` to ensure the configuration entry was deleted: You can then use `kubectl get` to ensure the configuration entry was deleted:
```shell-session ```shell-session
$ kubectl get servicedefaults foo $ kubectl get servicedefaults foo
@ -167,7 +167,7 @@ Error from server (NotFound): servicedefaults.consul.hashicorp.com "foo" not fou
#### Delete Hanging #### Delete Hanging
If running `kubectl delete` hangs without exiting, there may be If running `kubectl delete` hangs without exiting, there may be
a requirement inside Consul that prevents that configuration entry from being a dependent configuration entry registered with Consul that prevents the target configuration entry from being
deleted. For example, if you set the protocol of your service to `http` via `ServiceDefaults` and then deleted. For example, if you set the protocol of your service to `http` via `ServiceDefaults` and then
create a `ServiceSplitter`, you won't be able to delete the `ServiceDefaults`. create a `ServiceSplitter`, you won't be able to delete the `ServiceDefaults`.
@ -176,15 +176,15 @@ protocol back to the default which is `tcp`. Since `ServiceSplitter` requires
that the service has an `http` protocol, Consul will not allow the `ServiceDefaults` that the service has an `http` protocol, Consul will not allow the `ServiceDefaults`
to be deleted since that would put Consul into a broken state. to be deleted since that would put Consul into a broken state.
In order to delete the `ServiceDefaults` config you would need to first delete In order to delete the `ServiceDefaults` config, you would need to first delete
the `ServiceSplitter`. the `ServiceSplitter`.
## Specifications ## Specifications
### ProxyDefaults ### ProxyDefaults
[proxy-defaults](/docs/agent/config-entries/proxy-defaults) A [proxy-defaults](/docs/agent/config-entries/proxy-defaults)
configures global defaults across all proxies. entry configures global defaults across all proxies.
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
@ -193,18 +193,18 @@ metadata:
name: global name: global
spec: spec:
config: config:
envoy_tracing_json: '{"http":{"name":"envoy.zipkin","config":{"collector_cluster":"zipkin","collector_endpoint":"/api/v1/spans","shared_span_context":false}}}' envoy_tracing_json: '{"http":{"config":{"collector_cluster":"jaeger_9411","collector_endpoint":"/api/v2/spans"},"name":"envoy.zipkin"}}'
expose: expose:
checks: true checks: true
paths: paths:
- listenerPort: 80 - listenerPort: 80
localPathPort: 42 localPathPort: 42
path: /test/path path: /test/path
protocol: tcp protocol: http
- listenerPort: 8080 - listenerPort: 8080
localPathPort: 4201 localPathPort: 4201
path: /root/test/path path: /root/test/path
protocol: https protocol: http2
meshGateway: meshGateway:
mode: local mode: local
``` ```
@ -224,8 +224,8 @@ Notes:
### ServiceDefaults ### ServiceDefaults
[service-defaults](/docs/agent/config-entries/service-defaults) A [service-defaults](/docs/agent/config-entries/service-defaults)
configures a specific service. entry configures a specific service.
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
@ -242,7 +242,7 @@ spec:
- listenerPort: 80 - listenerPort: 80
path: /path path: /path
localPathPort: 9000 localPathPort: 9000
protocol: tcp protocol: http
- listenerPort: 8080 - listenerPort: 8080
path: /another-path path: /another-path
localPathPort: 9091 localPathPort: 9091
@ -259,8 +259,8 @@ Notes:
### ServiceIntentions <sup>(Beta)</sup> ### ServiceIntentions <sup>(Beta)</sup>
[service-intentions](/docs/agent/config-entries/service-intentions) A [service-intentions](/docs/agent/config-entries/service-intentions)
configures traffic authorization for a destination service. entry configures traffic authorization for a destination service.
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
@ -307,14 +307,15 @@ spec:
Notes: Notes:
1. This resource is only supported in Consul 1.9.0. 1. This resource is only supported in Consul 1.9.0.
1. Unlike the other configuration entries, the value of `metadata.name` does not 1. **Unlike the other configuration entries**, the value of `metadata.name` does not
define which service the intention applies to. It can be set to any value define which service the intention applies to.
however we recommend setting it to the name of the destination service the
intention is configuring.
Instead, the name of the service this intention Instead, the name of the service this intention
is configuring is set in `spec.destination.name`. is configuring is set in `spec.destination.name`.
The `metadata.name` field can be set to any value,
however, we recommend setting it to the name of the destination service the
intention is configuring.
1. Wildcard intentions can be created by setting `spec.destination.name` to `*` and/or 1. Wildcard intentions can be created by setting `spec.destination.name` to `*` and/or
`spec.sources[].name` to `*`. For example to create a `deny` intention that applies `spec.sources[].name` to `*`. For example to create a `deny` intention that applies
to all services: to all services:
@ -337,8 +338,8 @@ Notes:
### ServiceResolver ### ServiceResolver
[service-resolver](/docs/agent/config-entries/service-resolver) A [service-resolver](/docs/agent/config-entries/service-resolver)
configures which service instances should satisfy Connect upstream discovery requests for a given service name. entry configures which service instances should satisfy Connect upstream discovery requests for a given service name.
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
@ -401,8 +402,8 @@ Notes:
### ServiceRouter ### ServiceRouter
[service-router](/docs/agent/config-entries/service-router) A [service-router](/docs/agent/config-entries/service-router)
configures traffic routing and manipulation at networking layer 7 (e.g. HTTP). entry configures traffic routing and manipulation at networking layer 7 (e.g. HTTP).
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
@ -454,8 +455,8 @@ Notes:
### ServiceSplitter ### ServiceSplitter
[service-splitter](/docs/agent/config-entries/service-splitter) A [service-splitter](/docs/agent/config-entries/service-splitter)
configures splitting incoming requests across different subsets of a single service. entry configures splitting incoming requests across different subsets of a single service.
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
@ -464,13 +465,13 @@ metadata:
name: your-service-name name: your-service-name
spec: spec:
splits: splits:
- weight: 50.1 - weight: 25.5
service: foo service: foo
serviceSubset: bar serviceSubset: v1
namespace: baz namespace: baz
- weight: 49.9 - weight: 74.5
service: foo service: foo
serviceSubset: bar serviceSubset: v2
namespace: baz namespace: baz
``` ```