Skip to content

Commit dc36451

Browse files
committed
Update dependencies
1 parent 452b4c7 commit dc36451

File tree

4 files changed

+1945
-1845
lines changed

4 files changed

+1945
-1845
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
contents: write
1010
steps:
1111
- name: Checkout source code
12-
uses: actions/checkout@v3.3.0
12+
uses: actions/checkout@v4.1.0
1313
- name: Deploy website
1414
uses: redkubes/docusaurus-deploy-action@v1.2
1515
with:

docs/getting-started/installation.md

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -48,69 +48,23 @@ kapp deploy -a kapp-controller -y \
4848
Add the Kadras repository to make the platform packages available to the cluster.
4949

5050
```shell
51-
kubectl create namespace kadras-packages
5251
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`.
70-
71-
```shell
72-
kubectl create secret docker-registry supply-chain-registry-credentials \
73-
--docker-server="${SUPPLY_CHAIN_REGISTRY_HOSTNAME}" \
74-
--docker-username="${SUPPLY_CHAIN_REGISTRY_USERNAME}" \
75-
--docker-password="${SUPPLY_CHAIN_REGISTRY_TOKEN}" \
76-
--namespace=kadras-packages
52+
--url ghcr.io/kadras-io/kadras-packages:0.14.0 \
53+
-n kadras-packages --create-namespace
7754
```
7855

7956
## Configure the Platform
8057

81-
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.
8259

8360
```yaml title="values.yml"
8461
platform:
62+
profile: run
63+
infrastructure_provider: local
8564
ingress:
8665
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>
10766
```
10867
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-
11468
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.
11569

11670
## Install the Platform
@@ -120,7 +74,7 @@ Reference the `values.yml` file you created in the previous step and install the
12074
```shell
12175
kctrl package install -i engineering-platform \
12276
-p engineering-platform.packages.kadras.io \
123-
-v 0.9.2 \
77+
-v 0.12.0 \
12478
-n kadras-packages \
12579
--values-file values.yml
12680
```

docs/getting-started/workload.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,20 @@ sidebar_position: 2
33
description: Create and view an application workload
44
---
55

6-
# Create a Workload
6+
# Deploy a Workload
77

8-
Kadras Engineering Platform provides out-of-the-box capabilities to support application development workflows from source code to URL.
8+
Kadras Engineering Platform provides capabilities to support application deployment workflows from image to URL based on Knative or plain Kubernetes.
99

10-
First, check out the sample Band Service application.
10+
First, ensure you have the [Knative CLI](https://knative.dev/docs/client/) installed.
1111

12-
```shell
13-
git clone https://github.com/thomasvitale/band-service
14-
```
15-
16-
## Deploy a workload
17-
18-
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).
21-
22-
```shell
23-
carto apps workload create --file config/workload.yml
24-
```
25-
26-
Alternatively, you can create a workload using the Kubernetes CLI.
12+
Then, deploy an application from its OCI image.
2713

2814
```shell
29-
kubectl apply -f config/workload.yml
15+
kn service create band-service --image ghcr.io/thomasvitale/band-service
3016
```
3117

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.
3719

3820
```shell
39-
carto apps workload get band-service
21+
https band-service.default.127.0.0.1.sslip.io --verify no
4022
```
41-
42-
The application will be available at `https://band-service.default.127.0.0.1.sslip.io`.

0 commit comments

Comments
 (0)