Skip to content

Commit 1116603

Browse files
jiparisjiparis
authored
chore(docs): fix README to use HTML-encoded characters (#1062)
Signed-off-by: Jose I. Paris <[email protected]>
1 parent 76dddcc commit 1116603

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

‎deployment/chainloop/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ During installation, you'll need to provide
5151

5252
- Open ID Connect Identity Provider (IDp) settings i.e [Auth0 settings](https://auth0.com/docs/get-started/applications/application-settings#basic-information)
5353
- Connection settings for a secrets storage backend, either [Hashicorp Vault](https://www.vaultproject.io/) or [AWS Secrets Manager](https://aws.amazon.com/secrets-manager)
54-
- ECDSA (ES512) key-pair used for Controlplane <-> CAS Authentication
54+
- ECDSA (ES512) key-pair used for Controlplane to CAS Authentication
5555

5656
Instructions on how to create the ECDSA keypair can be found [here](#generate-a-ecdsa-key-pair).
5757

@@ -159,7 +159,7 @@ During installation, you'll need to provide
159159

160160
- Open ID Connect Identity Provider (IDp) settings i.e [Auth0 settings](https://auth0.com/docs/get-started/applications/application-settings#basic-information)
161161
- ~~Connection settings for a secrets storage backend, either [Hashicorp Vault](https://www.vaultproject.io/) or [AWS Secrets Manager](https://aws.amazon.com/secrets-manager)~~
162-
- ~~ECDSA (ES512) key-pair used for Controlplane <-> CAS Authentication~~
162+
- ~~ECDSA (ES512) key-pair used for Controlplane to CAS Authentication~~
163163

164164
#### Installation examples for development mode
165165

@@ -482,10 +482,10 @@ chainloop config save \
482482

483483
### Authentication
484484

485-
| Name | Description | Value |
486-
| ------------------ | ---------------------------------------------------------------------- | ----- |
487-
| `casJWTPrivateKey` | ECDSA (ES512) private key used for Controlplane <-> CAS Authentication | `""` |
488-
| `casJWTPublicKey` | ECDSA (ES512) public key | `""` |
485+
| Name | Description | Value |
486+
| ------------------ | --------------------------------------------------------------------- | ----- |
487+
| `casJWTPrivateKey` | ECDSA (ES512) private key used for Controlplane to CAS Authentication | `""` |
488+
| `casJWTPublicKey` | ECDSA (ES512) public key | `""` |
489489

490490
### Control Plane
491491

@@ -537,12 +537,12 @@ chainloop config save \
537537
| `controlplane.service.type` | Service type | `ClusterIP` |
538538
| `controlplane.service.port` | Service port | `80` |
539539
| `controlplane.service.targetPort` | Service target Port | `http` |
540-
| `controlplane.service.nodePorts.http` | Node port for HTTP. NOTE: choose port between <30000-32767> | |
540+
| `controlplane.service.nodePorts.http` | Node port for HTTP. NOTE: choose port between [30000-32767] | |
541541
| `controlplane.serviceAPI.type` | Service type | `ClusterIP` |
542542
| `controlplane.serviceAPI.port` | Service port | `80` |
543543
| `controlplane.serviceAPI.targetPort` | Service target Port | `grpc` |
544544
| `controlplane.serviceAPI.annotations` | Service annotations | |
545-
| `controlplane.serviceAPI.nodePorts.http` | Node port for HTTP. NOTE: choose port between <30000-32767> | |
545+
| `controlplane.serviceAPI.nodePorts.http` | Node port for HTTP. NOTE: choose port between [30000-32767] | |
546546
| `controlplane.ingress.enabled` | Enable ingress record generation for %%MAIN_CONTAINER_NAME%% | `false` |
547547
| `controlplane.ingress.pathType` | Ingress path type | `ImplementationSpecific` |
548548
| `controlplane.ingress.hostname` | Default host for the ingress record | `cp.dev.local` |
@@ -620,12 +620,12 @@ chainloop config save \
620620
| `cas.service.type` | Service type | `ClusterIP` |
621621
| `cas.service.port` | Service port | `80` |
622622
| `cas.service.targetPort` | Service target Port | `http` |
623-
| `cas.service.nodePorts.http` | Node port for HTTP. NOTE: choose port between <30000-32767> | |
623+
| `cas.service.nodePorts.http` | Node port for HTTP. NOTE: choose port between [30000-32767] | |
624624
| `cas.serviceAPI.type` | Service type | `ClusterIP` |
625625
| `cas.serviceAPI.port` | Service port | `80` |
626626
| `cas.serviceAPI.targetPort` | Service target Port | `grpc` |
627627
| `cas.serviceAPI.annotations` | Service annotations | |
628-
| `cas.serviceAPI.nodePorts.http` | Node port for HTTP. NOTE: choose port between <30000-32767> | |
628+
| `cas.serviceAPI.nodePorts.http` | Node port for HTTP. NOTE: choose port between [30000-32767] | |
629629
| `cas.ingress.enabled` | Enable ingress record generation for %%MAIN_CONTAINER_NAME%% | `false` |
630630
| `cas.ingress.pathType` | Ingress path type | `ImplementationSpecific` |
631631
| `cas.ingress.hostname` | Default host for the ingress record | `cas.dev.local` |

‎deployment/chainloop/values.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ secretsBackend:
6969
## @section Authentication
7070
##
7171

72-
## ECDSA (ES512) key-pair used for Controlplane <-> CAS Authentication
72+
## ECDSA (ES512) key-pair used for Controlplane to; CAS Authentication
7373
## The controlplane will use the private key to generate a JWT at user request
7474
## The CAS will use the public key to verify the authenticity of that token
7575
## If development=true is set, a development key will be configured automatically
7676
## otherwise you'll need to provide new keys via .Values.casJWTPrivateKey and .Values.cas.casJWTPublicKey
7777

78-
## @param casJWTPrivateKey ECDSA (ES512) private key used for Controlplane <-> CAS Authentication
78+
## @param casJWTPrivateKey ECDSA (ES512) private key used for Controlplane to CAS Authentication
7979
##
8080
## To generate one
8181
## openssl ecparam -name secp521r1 -genkey -noout -out private.ec.key
@@ -208,7 +208,7 @@ controlplane:
208208
port: 80
209209
## @param controlplane.service.targetPort Service target Port
210210
targetPort: http
211-
## @extra controlplane.service.nodePorts.http Node port for HTTP. NOTE: choose port between <30000-32767>
211+
## @extra controlplane.service.nodePorts.http Node port for HTTP. NOTE: choose port between [30000-32767]
212212
# nodePorts:
213213
# http: "30800"
214214
annotations:
@@ -227,7 +227,7 @@ controlplane:
227227
## @skip controlplane.serviceAPI.annotations.traefik.ingress.kubernetes.io/service.serversscheme
228228
traefik.ingress.kubernetes.io/service.serversscheme: h2c
229229

230-
## @extra controlplane.serviceAPI.nodePorts.http Node port for HTTP. NOTE: choose port between <30000-32767>
230+
## @extra controlplane.serviceAPI.nodePorts.http Node port for HTTP. NOTE: choose port between [30000-32767]
231231
# nodePorts:
232232
# http: "30900"
233233

@@ -551,7 +551,7 @@ cas:
551551
port: 80
552552
## @param cas.service.targetPort Service target Port
553553
targetPort: http
554-
## @extra cas.service.nodePorts.http Node port for HTTP. NOTE: choose port between <30000-32767>
554+
## @extra cas.service.nodePorts.http Node port for HTTP. NOTE: choose port between [30000-32767]
555555
# nodePorts:
556556
# http: "30800"
557557
annotations:
@@ -570,7 +570,7 @@ cas:
570570
## @skip cas.serviceAPI.annotations.traefik.ingress.kubernetes.io/service.serversscheme
571571
traefik.ingress.kubernetes.io/service.serversscheme: h2c
572572

573-
## @extra cas.serviceAPI.nodePorts.http Node port for HTTP. NOTE: choose port between <30000-32767>
573+
## @extra cas.serviceAPI.nodePorts.http Node port for HTTP. NOTE: choose port between [30000-32767]
574574
# nodePorts:
575575
# http: "30901"
576576

0 commit comments

Comments
 (0)