Skip to content

Commit ffba4ca

Browse files
author
Filip Chlebowski
committed
feat(chart): Update readme with httproute params
1 parent b3177e3 commit ffba4ca

2 files changed

Lines changed: 60 additions & 41 deletions

File tree

‎deployment/chainloop/README.md‎

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -671,6 +671,14 @@ Once done, you can access with [two predefined users](https://github.com/chainlo
671671
| `controlplane.ingressAPI.extraTls` | TLS configuration for additional hostname(s) to be covered with this ingress record | `[]` |
672672
| `controlplane.ingressAPI.secrets` | Custom TLS certificates as secrets | `[]` |
673673
| `controlplane.ingressAPI.extraRules` | Additional rules to be covered with this ingress record | `[]` |
674+
| `controlplane.httpRoute.enabled` | Enable HTTPRoute generation for controlplane | `false` |
675+
| `controlplane.httpRoute.annotations` | Additional annotations for the HTTPRoute resource | `{}` |
676+
| `controlplane.httpRoute.labels` | Additional labels for the HTTPRoute resource | `{}` |
677+
| `controlplane.httpRoute.parentRefs` | Gateways the HTTPRoute is attached to. If unspecified, it'll be attached to Gateway named 'gateway' in the same namespace. | `[]` |
678+
| `controlplane.httpRoute.hostnames` | List of hostnames matching HTTP header | `[]` |
679+
| `controlplane.httpRoute.matches` | List of match rules applied to the HTTPRoute for the default svc backend reference | `[]` |
680+
| `controlplane.httpRoute.filters` | List of filter rules applied to the HTTPRoute for the default svc backend reference | `[]` |
681+
| `controlplane.httpRoute.extraRules` | List of extra rules applied to the HTTPRoute | `[]` |
674682

675683
### Controlplane Misc
676684

@@ -847,6 +855,14 @@ Once done, you can access with [two predefined users](https://github.com/chainlo
847855
| `cas.ingressAPI.extraTls` | TLS configuration for additional hostname(s) to be covered with this ingress record | `[]` |
848856
| `cas.ingressAPI.secrets` | Custom TLS certificates as secrets | `[]` |
849857
| `cas.ingressAPI.extraRules` | Additional rules to be covered with this ingress record | `[]` |
858+
| `cas.httpRoute.enabled` | Enable HTTPRoute generation for CAS | `false` |
859+
| `cas.httpRoute.annotations` | Additional annotations for the HTTPRoute resource | `{}` |
860+
| `cas.httpRoute.labels` | Additional labels for the HTTPRoute resource | `{}` |
861+
| `cas.httpRoute.parentRefs` | Gateways the HTTPRoute is attached to. If unspecified, it'll be attached to Gateway named 'gateway' in the same namespace. | `[]` |
862+
| `cas.httpRoute.hostnames` | List of hostnames matching HTTP header | `[]` |
863+
| `cas.httpRoute.matches` | List of match rules applied to the HTTPRoute for the default svc backend reference | `[]` |
864+
| `cas.httpRoute.filters` | List of filter rules applied to the HTTPRoute for the default svc backend reference | `[]` |
865+
| `cas.httpRoute.extraRules` | List of extra rules applied to the HTTPRoute | `[]` |
850866

851867
### CAS Misc
852868

@@ -928,23 +944,22 @@ Once done, you can access with [two predefined users](https://github.com/chainlo
928944

929945
### Dependencies
930946

931-
| Name | Description | Value |
932-
| ------------------------------------ | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
933-
| `postgresql.enabled` | Switch to enable or disable the PostgreSQL helm chart | `true` |
934-
| `postgresql.auth.enablePostgresUser` | Assign a password to the "postgres" admin user. Otherwise, remote access will be blocked for this user | `false` |
935-
| `postgresql.auth.username` | Name for a custom user to create | `chainloop` |
936-
| `postgresql.auth.password` | Password for the custom user to create | `chainlooppwd` |
937-
| `postgresql.auth.database` | Name for a custom database to create | `chainloop-cp` |
938-
| `postgresql.auth.existingSecret` | Name of existing secret to use for PostgreSQL credentials | `""` |
939-
| `vault.server.args` | Arguments to pass to the vault server. This is useful for setting the server in development mode | `["server","-dev"]` |
940-
| `vault.server.config` | Configuration for the vault server. Small override of default Bitnami configuration | `storage "inmem" {}
941-
disable_mlock = true
942-
ui = true
943-
service_registration "kubernetes" {}` |
944-
| `vault.server.extraEnvVars[0].name` | Root token for the vault server | `VAULT_DEV_ROOT_TOKEN_ID` |
945-
| `vault.server.extraEnvVars[0].value` | The value of the root token. Default: notasecret | `notasecret` |
946-
| `vault.server.extraEnvVars[1].name` | Address to listen on development mode | `VAULT_DEV_LISTEN_ADDRESS` |
947-
| `vault.server.extraEnvVars[1].value` | The address to listen on. Default: [::]:8200 | `[::]:8200` |
947+
| Name | Description | Value |
948+
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
949+
| `postgresql.enabled` | Switch to enable or disable the PostgreSQL helm chart | `true` |
950+
| `postgresql.auth.enablePostgresUser` | Assign a password to the "postgres" admin user. Otherwise, remote access will be blocked for this user | `false` |
951+
| `postgresql.auth.username` | Name for a custom user to create | `chainloop` |
952+
| `postgresql.auth.password` | Password for the custom user to create | `chainlooppwd` |
953+
| `postgresql.auth.database` | Name for a custom database to create | `chainloop-cp` |
954+
| `postgresql.auth.existingSecret` | Name of existing secret to use for PostgreSQL credentials | `""` |
955+
| `vault.server.command` | Override default container command | `["/vault-init.sh"]` |
956+
| `vault.server.args` | Override default container args | `[""]` |
957+
| `vault.server.extraVolumes[0].name` | Name of the extra volume | `vault-init` |
958+
| `vault.server.extraVolumes[0].configMap.name` | Name of the ConfigMap to mount | `{{ include "vault.server.fullname" . }}-init` |
959+
| `vault.server.extraVolumes[0].configMap.defaultMode` | Default mode for the ConfigMap files | `755` |
960+
| `vault.server.extraVolumeMounts[0].name` | Name of the volume to mount | `vault-init` |
961+
| `vault.server.extraVolumeMounts[0].mountPath` | Path where the volume should be mounted | `/vault-init.sh` |
962+
| `vault.server.extraVolumeMounts[0].subPath` | Subpath within the volume to mount | `vault-init.sh` |
948963

949964
## License
950965

‎deployment/chainloop/values.yaml‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -605,37 +605,37 @@ controlplane:
605605
## ref: https://gateway-api.sigs.k8s.io/guides/http-routing/
606606
##
607607
httpRoute:
608-
## @param httpRoute.enabled Enable HTTPRoute generation for WordPress
608+
## @param controlplane.httpRoute.enabled Enable HTTPRoute generation for controlplane
609609
##
610610
enabled: false
611-
## @param httpRoute.annotations Additional annotations for the HTTPRoute resource
611+
## @param controlplane.httpRoute.annotations Additional annotations for the HTTPRoute resource
612612
##
613613
annotations: {}
614-
## @param httpRoute.labels Additional labels for the HTTPRoute resource
614+
## @param controlplane.httpRoute.labels Additional labels for the HTTPRoute resource
615615
##
616616
labels: {}
617-
## @param httpRoute.parentRefs Gateways the HTTPRoute is attached to. If unspecified, it'll be attached to Gateway named 'gateway' in the same namespace.
617+
## @param controlplane.httpRoute.parentRefs Gateways the HTTPRoute is attached to. If unspecified, it'll be attached to Gateway named 'gateway' in the same namespace.
618618
## e.g:
619619
## parentRefs:
620620
## - name: my-gateway
621621
## sectionName: http
622622
## namespace: default
623623
##
624624
parentRefs: []
625-
## @param httpRoute.hostnames [array] List of hostnames matching HTTP header
625+
## @param controlplane.httpRoute.hostnames [array] List of hostnames matching HTTP header
626626
##
627627
hostnames:
628628
- cp.dev.local
629-
## @param httpRoute.matches [array] List of match rules applied to the HTTPRoute for the default svc backend reference
629+
## @param controlplane.httpRoute.matches [array] List of match rules applied to the HTTPRoute for the default svc backend reference
630630
##
631631
matches:
632632
- path:
633633
type: PathPrefix
634634
value: /
635-
## @param httpRoute.filters List of filter rules applied to the HTTPRoute for the default svc backend reference
635+
## @param controlplane.httpRoute.filters List of filter rules applied to the HTTPRoute for the default svc backend reference
636636
##
637637
filters: []
638-
## @param httpRoute.extraRules List of extra rules applied to the HTTPRoute
638+
## @param controlplane.httpRoute.extraRules List of extra rules applied to the HTTPRoute
639639
## e.g:
640640
## extraRules:
641641
## - matches:
@@ -651,7 +651,7 @@ controlplane:
651651
## remove:
652652
## - User-Agent
653653
## backendRefs:
654-
## - name: wordpress
654+
## - name: chainloop-controlplane
655655
## port: 80
656656
##
657657
extraRules: []
@@ -1407,37 +1407,37 @@ cas:
14071407
## ref: https://gateway-api.sigs.k8s.io/guides/http-routing/
14081408
##
14091409
httpRoute:
1410-
## @param httpRoute.enabled Enable HTTPRoute generation for WordPress
1410+
## @param cas.httpRoute.enabled Enable HTTPRoute generation for CAS
14111411
##
14121412
enabled: false
1413-
## @param httpRoute.annotations Additional annotations for the HTTPRoute resource
1413+
## @param cas.httpRoute.annotations Additional annotations for the HTTPRoute resource
14141414
##
14151415
annotations: {}
1416-
## @param httpRoute.labels Additional labels for the HTTPRoute resource
1416+
## @param cas.httpRoute.labels Additional labels for the HTTPRoute resource
14171417
##
14181418
labels: {}
1419-
## @param httpRoute.parentRefs Gateways the HTTPRoute is attached to. If unspecified, it'll be attached to Gateway named 'gateway' in the same namespace.
1419+
## @param cas.httpRoute.parentRefs Gateways the HTTPRoute is attached to. If unspecified, it'll be attached to Gateway named 'gateway' in the same namespace.
14201420
## e.g:
14211421
## parentRefs:
14221422
## - name: my-gateway
14231423
## sectionName: http
14241424
## namespace: default
14251425
##
14261426
parentRefs: []
1427-
## @param httpRoute.hostnames [array] List of hostnames matching HTTP header
1427+
## @param cas.httpRoute.hostnames [array] List of hostnames matching HTTP header
14281428
##
14291429
hostnames:
14301430
- cas.dev.local
1431-
## @param httpRoute.matches [array] List of match rules applied to the HTTPRoute for the default svc backend reference
1431+
## @param cas.httpRoute.matches [array] List of match rules applied to the HTTPRoute for the default svc backend reference
14321432
##
14331433
matches:
14341434
- path:
14351435
type: PathPrefix
14361436
value: /
1437-
## @param httpRoute.filters List of filter rules applied to the HTTPRoute for the default svc backend reference
1437+
## @param cas.httpRoute.filters List of filter rules applied to the HTTPRoute for the default svc backend reference
14381438
##
14391439
filters: []
1440-
## @param httpRoute.extraRules List of extra rules applied to the HTTPRoute
1440+
## @param cas.httpRoute.extraRules List of extra rules applied to the HTTPRoute
14411441
## e.g:
14421442
## extraRules:
14431443
## - matches:
@@ -1453,7 +1453,7 @@ cas:
14531453
## remove:
14541454
## - User-Agent
14551455
## backendRefs:
1456-
## - name: wordpress
1456+
## - name: chainloop-cas
14571457
## port: 80
14581458
##
14591459
extraRules: []
@@ -1790,12 +1790,16 @@ postgresql:
17901790

17911791
## Bitnami Hashicorp Vault chart configuration
17921792
## ref: https://github.com/bitnami/charts/blob/main/bitnami/vault/values.yaml
1793-
## @param vault.server.args Arguments to pass to the vault server. This is useful for setting the server in development mode
1794-
## @param vault.server.config Configuration for the vault server. Small override of default Bitnami configuration
1795-
## @param vault.server.extraEnvVars[0].name Root token for the vault server
1796-
## @param vault.server.extraEnvVars[0].value The value of the root token. Default: notasecret
1797-
## @param vault.server.extraEnvVars[1].name Address to listen on development mode
1798-
## @param vault.server.extraEnvVars[1].value The address to listen on. Default: [::]:8200
1793+
## @skip vault.extraDeploy Array of extra objects to deploy with Vault (evaluated as a template)
1794+
## @param vault.server.command Override default container command
1795+
## @param vault.server.args Override default container args
1796+
## @skip vault.server.config Configuration for the vault server
1797+
## @param vault.server.extraVolumes[0].name Name of the extra volume
1798+
## @param vault.server.extraVolumes[0].configMap.name Name of the ConfigMap to mount
1799+
## @param vault.server.extraVolumes[0].configMap.defaultMode Default mode for the ConfigMap files
1800+
## @param vault.server.extraVolumeMounts[0].name Name of the volume to mount
1801+
## @param vault.server.extraVolumeMounts[0].mountPath Path where the volume should be mounted
1802+
## @param vault.server.extraVolumeMounts[0].subPath Subpath within the volume to mount
17991803
vault:
18001804
extraDeploy:
18011805
- |

0 commit comments

Comments
 (0)