Skip to content

Commit c7f9c78

Browse files
committed
Update local installation docs
1 parent cc72763 commit c7f9c78

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

docs/getting-started/installation.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Ensure you have the following tools installed in your local environment:
1414
* Kubernetes [`kubectl`](https://kubectl.docs.kubernetes.io/installation/kubectl)
1515
* [kind](https://kind.sigs.k8s.io)
1616
* Carvel [`kctrl`](https://carvel.dev/kapp-controller/docs/latest/install)
17-
* Carvel [`kapp`](https://carvel.dev/kapp-controller/docs/latest/install/#installing-kapp-controller-cli-kctrl) CLI.
17+
* Carvel [`kapp`](https://carvel.dev/kapp-controller/docs/latest/install/#installing-kapp-controller-cli-kctrl).
1818

1919
Then, create a local Kubernetes cluster with kind.
2020

@@ -89,21 +89,27 @@ The installation of the Kadras Engineering Platform can be configured via YAML.
8989
```yaml title="values.yml"
9090
platform:
9191
ingress:
92-
domain: <domain>
92+
domain: 127.0.0.1.sslip.io
9393

9494
oci_registry:
9595
server: <oci-server>
9696
repository: <oci-repository>
9797

98+
contour:
99+
envoy:
100+
service:
101+
type: ClusterIP
102+
98103
workspace_provisioner:
99104
namespaces:
100105
- name: default
101106
```
102107
103-
* `<domain>` is the base domain name the platform will use to configure the Ingress controller. It must be a valid DNS name. For example, `lab.thomasvitale.com`.
104108
* `<oci-server>` is the server of the OCI registry where the platform will publish and consume OCI images. It must be the same used in the previous step when creating a Secret with the OCI registry credentials. For example, `ghcr.io`, `gcr.io`, `quay.io`, `index.docker.io`.
105109
* `<oci-repository>` is the repository in the OCI registry where the platform will publish and consume OCI images. It must be the same used in the previous step when creating a Secret with the OCI registry credentials. For example, it might be your username or organization name depending on which OCI server you're using.
106110

111+
The Ingress is configured with the special domain `127.0.0.1.sslip.io` which will resolve to your localhost and be accessible via the kind cluster.
112+
107113
## Install the Platform
108114

109115
Reference the `values.yml` file you created in the previous step and install the Kadras Engineering Platform.

docs/getting-started/workload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ git clone https://github.com/thomasvitale/band-service
1717

1818
The platform exposes a Workload API based on [Cartographer](https://cartographer.sh) that developers use to trigger the supply chain for a given application.
1919

20-
Deploy the Band Service application by creating a workload based on the configuration available in `config/workload.yml`.
20+
Deploy the Band Service application by creating a workload based on the configuration available in `config/workload.yml` using the [Cartographer CLI](https://github.com/ThomasVitale/cartographer-cli).
2121

2222
```shell
2323
carto apps workload create --file config/workload.yml

0 commit comments

Comments
 (0)