Skip to content

Commit e5e31dc

Browse files
kvapsNickVolynkin
authored andcommitted
[docs] Introduce expose-services, expose-ingress and expose-external-ips options
Signed-off-by: Andrei Kvapil <[email protected]>
1 parent f2f4ab4 commit e5e31dc

6 files changed

Lines changed: 27 additions & 8 deletions

File tree

‎content/en/docs/getting-started/first-deployment.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,8 +507,8 @@ kubectl patch -n cozy-system cm cozystack --type=merge -p '{"data":{
507507
In Cozystack v0.30.6 and earlier, this was done differently:
508508

509509
```bash
510-
kubectl patch -n tenant-root ingresses.apps.cozystack.io ingress --type=merge -p '{"spec":{
511-
"dashboard": true
510+
kubectl patch cm -n cozy-system cozystack --type merge -p='{"data":{
511+
"external-services": "dashboard"
512512
}}'
513513
```
514514
{{% /alert %}}

‎content/en/docs/operations/bundles/paas-full.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ data:
2727
ipv4-join-cidr: "100.64.0.0/16"
2828
root-host: example.org
2929
api-server-endpoint: https://192.168.100.10:6443
30+
expose-services: "api,dashboard,cdi-uploadproxy,vm-exportproxy"
3031
```
3132
3233
### Configuration parameters
@@ -44,6 +45,9 @@ data:
4445
| `api-server-endpoint` | used for generating kubeconfig files for your users. It is recommended to use globally accessible IP addresses instead of local ones. |
4546
| `oidc-enabled` | used to enable [oidc](/docs/operations/oidc/) feature in Cozystack (default: `false`) |
4647
| `telemetry-enabled` | used to enable [telemetry](/docs/operations/telemetry/) feature in Cozystack (default: `true`) |
48+
| `expose-services` | Comma-separated list of services to expose to the internet. Possible values: `api,dashboard,cdi-uploadproxy,vm-exportproxy` |
49+
| `expose-ingress` | Ingress controller to use for exposing services. (default: `tenant-root`) |
50+
| `expose-external-ips` | Comma-separated list of external IPs used for specified ingress controller. If not specified it will use LoadBalancer service by default |
4751

4852
[disable-components]: {{% ref "docs/operations/bundles#how-to-disable-some-components-from-bundle" %}}
4953
[overwrite-parameters]: {{% ref "docs/operations/bundles#how-to-overwrite-parameters-for-specific-components" %}}

‎content/en/docs/operations/bundles/paas-hosted.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ data:
2424
bundle-name: "paas-hosted"
2525
root-host: example.org
2626
api-server-endpoint: https://192.168.100.10:6443
27+
expose-services: "api,dashboard"
2728
```
2829
2930
### Configuration parameters
@@ -39,6 +40,9 @@ data:
3940
| `api-server-endpoint` | used for generating kubeconfig files for your users. It is recommended to use globally accessible IP addresses instead of local ones. |
4041
| `oidc-enabled` | used to enable [oidc](/docs/operations/oidc/) feature in Cozystack (default: `false`) |
4142
| `telemetry-enabled` | used to enable [telemetry](/docs/operations/telemetry/) feature in Cozystack (default: `true`) |
43+
| `expose-services` | Comma-separated list of services to expose to the internet. Possible values: `api,dashboard,cdi-uploadproxy,vm-exportproxy` |
44+
| `expose-ingress` | Ingress controller to use for exposing services. (default: `tenant-root`) |
45+
| `expose-external-ips` | Comma-separated list of external IPs used for specified ingress controller. If not specified it will use LoadBalancer service by default |
4246

4347
[disable-components]: {{% ref "docs/operations/bundles#how-to-disable-some-components-from-bundle" %}}
4448
[overwrite-parameters]: {{% ref "docs/operations/bundles#how-to-overwrite-parameters-for-specific-components" %}}

‎content/en/docs/operations/faq.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,12 @@ kubectl patch -n tenant-root ingresses.apps.cozystack.io ingress --type=merge -p
7070
"192.168.100.13"
7171
]
7272
}}'
73+
74+
kubectl patch -n cozy-system configmap cozystack --type=merge -p '{
75+
"data": {
76+
"expose-external-ips": "192.168.100.11,192.168.100.12,192.168.100.13"
77+
}
78+
}'
7379
```
7480

7581
After that, your Ingress will be available on the specified IPs:

‎content/en/docs/operations/oidc/enable_oidc.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,14 @@ If all prerequisites are met, you can proceed with the configuration steps.
4040

4141
### Step 1: Enable OIDC in Cozystack
4242

43-
Edit your Cozystack ConfigMap to enable OIDC:
43+
Edit your Cozystack ConfigMap to enable OIDC, this also will expose keycloak service automatically:
4444

4545
```bash
46-
kubectl patch -n cozy-system configmap cozystack --type=merge -p '{"data":{"oidc-enabled": "true"}}'
46+
kubectl patch -n cozy-system configmap cozystack --type=merge -p '{
47+
"data": {
48+
"oidc-enabled": "true",
49+
}
50+
}'
4751
```
4852

4953
If you need to add extra redirect URLs for the dashboard client (for example, when accessing the dashboard via port-forwarding), edit your Cozystack ConfigMap.

‎content/en/docs/operations/virtualization/virtual-machines.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,13 @@ This package defines a virtual machine disk used to store data. You can download
4949
5050
{{< note >}}
5151
If you want to let virtctl know about right endpoint for uploading images, you need to configure a cluster to specify an endpoint for it:
52-
1. Modify your `ingress` application to enable `cni-uploadproxy` option.
52+
1. Modify your cozystack config map, to enable cdi-uploadproxy along with the dashboard:
5353
```bash
54-
kubectl patch -n tenant-root ingresses.apps.cozystack.io ingress --type=merge -p '{"spec":{
55-
"cdiUploadProxy": true
54+
kubectl patch cm -n cozy-system cozystack --type merge -p='{"data":{
55+
"expose-services": "dashboard,cdi-uploadproxy"
5656
}}'
57-
57+
```
58+
5859
<!-- TODO: automate this -->
5960
2. Modify your cozystack config to provide a valid CDI uploadproxy endpoint:
6061
```yaml

0 commit comments

Comments
 (0)