Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@devantler
devantler committed Aug 20, 2024
1 parent b6bd23b commit 5650f4b
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 18 deletions.
6 changes: 0 additions & 6 deletions k8s/cert-manager/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ Cert Manager is a Kubernetes add-on to automate the management and issuance of T
- [Documentation](https://cert-manager.io/docs/)
- [Helm Chart](https://github.com/cert-manager/cert-manager/tree/master/deploy/charts/cert-manager)

## Post-build variables

| Variable | Description | Default | Required |
| -------------- | ------------------------- | :-----: | :------: |
| cluster_domain | The domain of the cluster | | ✓ |

## Custom Resources

- [Cluster Issuer - Self-Signed](cluster-issuers/selfsigned/README.md)
Expand Down
2 changes: 1 addition & 1 deletion k8s/cloudflared/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Cloudflared is a tunneling daemon based on Wireguard that can proxy a local webs

| Variable | Description | Default | Required |
| ------------------------ | ------------------------------------------- | :-----: | :------: |
| cloudflared_tunnel_token | The token for an existing Cloudflare tunnel | "" | ✓ |
| cloudflared_tunnel_token | The token for an existing Cloudflare tunnel | - | ✓ |
2 changes: 1 addition & 1 deletion k8s/gha-runner-scale-set-controller/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# GitHub Actions Runner Scale Set Controller

GitHub Actions Runner Scale Set Controller enables running self-hosted GitHub Actions runner scale sets in in Kubernetes.
GitHub Actions Runner Scale Set Controller enables self-hosting of GitHub Actions runners, such that GitHub Actions workflows can run on your own infrastructure.
2 changes: 1 addition & 1 deletion k8s/homepage/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ A modern, fully static, fast, secure fully proxied, highly customizable applicat

| Variable | Description | Default | Required |
| -------------------- | ------------------------- | :-----: | :------: |
| cluster_domain | The domain of the cluster | "" | ✓ |
| cluster_domain | The domain of the cluster | - | ✓ |
10 changes: 5 additions & 5 deletions k8s/oauth2-proxy/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ A reverse proxy that provides authentication with OpenID Connect and many more i

| Variable | Description | Default | Required |
| ---------------------------- | -------------------------------------------------------------- | :-----: | :------: |
| cluster_domain | The domain of the cluster | "" | ✓ |
| cluster_domain | The domain of the cluster | - | ✓ |
| oauth2_proxy_ingress_enabled | Whether to enable an ingress route to the OAuth2 Proxy service | true | ✕ |
| oauth2_proxy_client_id | The OAuth2 client ID | "" | ✓ |
| oauth2_proxy_client_secret | The OAuth2 client secret | "" | ✓ |
| oauth2_proxy_cookie_secret | The secret used to encrypt the cookie | "" | ✓ |
| oauth2_proxy_cookie_name | The name of the cookie | "" | ✕ |
| oauth2_proxy_client_id | The OAuth2 client ID | - | ✓ |
| oauth2_proxy_client_secret | The OAuth2 client secret | - | ✓ |
| oauth2_proxy_cookie_secret | The secret used to encrypt the cookie | - | ✓ |
| oauth2_proxy_cookie_name | The name of the cookie | - | ✕ |

To further configure OAuth2 Proxy, you must create a ConfigMap with the desired configuration, and deploy it in the oauth2-proxy namespace with the name `oauth2-proxy-configmap`.

Expand Down
2 changes: 1 addition & 1 deletion k8s/plantuml/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ A highly versatile tool that facilitates the rapid and straightforward creation

| Variable | Description | Default | Required |
| ------------------------ | ---------------------------------------------------------- | :-----: | :------: |
| cluster_domain | The domain of the cluster | "" | ✓ |
| cluster_domain | The domain of the cluster | - | ✓ |
| plantuml_ingress_enabled | Whether to enable an ingress route to the PlantUML service | true | ✕ |
2 changes: 1 addition & 1 deletion k8s/traefik/middlewares/basic-auth/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ This middleware adds basic authentication to requests.

| Variable | Description | Default | Required |
| ----------------------- | ---------------------------------------------- | :-----: | :------: |
| traefik_basic_auth_user | `htpasswd -nb user password \| openssl base64` | "" | ✓ |
| traefik_basic_auth_user | `htpasswd -nb user password \| openssl base64` | - | ✓ |
4 changes: 2 additions & 2 deletions k8s/traefik/middlewares/forward-auth/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ This middleware adds forward authentication to requests.

| Variable | Description | Default | Required |
| --------------------------------------------- | ----------------------------------------------- | :-----: | :------: |
| traefik_forward_auth_address | The address of the forward auth service | "" | ✓ |
| traefik_forward_auth_ssl_host | The host of the forward auth service | "" | ✓ |
| traefik_forward_auth_address | The address of the forward auth service | - | ✓ |
| traefik_forward_auth_ssl_host | The host of the forward auth service | - | ✓ |
| traefik_forward_auth_tls_insecure_skip_verify | Whether to skip verification of the certificate | true | ✕ |

0 comments on commit 5650f4b

Please sign in to comment.