You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/installation.md
+6-52Lines changed: 6 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,69 +48,23 @@ kapp deploy -a kapp-controller -y \
48
48
Add the Kadras repository to make the platform packages available to the cluster.
49
49
50
50
```shell
51
-
kubectl create namespace kadras-packages
52
51
kctrl package repository add -r kadras-packages \
53
-
--url ghcr.io/kadras-io/kadras-packages:0.11.1 \
54
-
-n kadras-packages
55
-
```
56
-
57
-
## Create a Secret for the OCI Registry
58
-
59
-
The platform will need to interact with a container registry. Create a Secret with the credentials to access your container registry with read/write permissions. It will be used by the platform to publish and consume OCI artifacts.
60
-
61
-
```shell
62
-
export SUPPLY_CHAIN_REGISTRY_HOSTNAME=<hostname>
63
-
export SUPPLY_CHAIN_REGISTRY_USERNAME=<username>
64
-
export SUPPLY_CHAIN_REGISTRY_TOKEN=<token>
65
-
```
66
-
67
-
*`<hostname>` is the server hosting the OCI registry. For example, `ghcr.io`, `gcr.io`, `quay.io`, `index.docker.io`.
68
-
*`<username>` is the username to access the OCI registry. Use `_json_key` if the hostname is `gcr.io`.
69
-
*`<token>` is a token with read/write permissions to access the OCI registry. Use the contents of the service account key json if the hostname is `gcr.io`.
The installation of the Kadras Engineering Platform can be configured via YAML. Create a `values.yml` file with any configuration you need for the platform. The following is a minimal configuration example.
58
+
The installation of the Kadras Engineering Platform can be configured via YAML. Create a `values.yml` file with any configuration you need for the platform. The following is a minimal configuration example for a local environment, based on the `run` installation profile.
82
59
83
60
```yaml title="values.yml"
84
61
platform:
62
+
profile: run
63
+
infrastructure_provider: local
85
64
ingress:
86
65
domain: 127.0.0.1.sslip.io
87
-
88
-
oci_registry:
89
-
server: <oci-server>
90
-
repository: <oci-repository>
91
-
92
-
contour:
93
-
envoy:
94
-
service:
95
-
type: ClusterIP
96
-
workload:
97
-
hostPorts:
98
-
enabled: true
99
-
100
-
workspace_provisioner:
101
-
namespaces:
102
-
- name: default
103
-
git:
104
-
credentials:
105
-
username: <git-username>
106
-
password: <git-token>
107
66
```
108
67
109
-
* `<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`.
110
-
* `<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.
111
-
* `<git-username>` is the name of your GitHub personal account or organization.
112
-
* `<git-token>` is a personal access token with read permissions to your GitHub repositories.
113
-
114
68
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.
115
69
116
70
## Install the Platform
@@ -120,7 +74,7 @@ Reference the `values.yml` file you created in the previous step and install the
The platform exposes a Workload API based on [Cartographer](https://cartographer.sh) that developers use to trigger the supply chain for a given application.
19
-
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).
Alternatively, you can create a workload using the Kubernetes CLI.
12
+
Then, deploy an application from its OCI image.
27
13
28
14
```shell
29
-
kubectl apply -f config/workload.yml
15
+
kn service create band-service --image ghcr.io/thomasvitale/band-service
30
16
```
31
17
32
-
The platform will check out the application source code and run it through a pre-configured supply chain that will package it as a container image, configure it and finally deploy it.
33
-
34
-
## View a workload
35
-
36
-
Using the Cartographer CLI, you can inspect the status of a workload and its supply chain.
18
+
The application will be available through a local URL with a self-signed certificate and autoscaling capabilities.
37
19
38
20
```shell
39
-
carto apps workload get band-service
21
+
https band-service.default.127.0.0.1.sslip.io --verify no
40
22
```
41
-
42
-
The application will be available at `https://band-service.default.127.0.0.1.sslip.io`.
0 commit comments