Skip to content

Commit df3e5a7

Browse files
committed
feat: Configure new platform profiles
1 parent 9e03758 commit df3e5a7

23 files changed

+106
-269
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ jobs:
1414
uses: kadras-io/github-reusable-workflows/.github/workflows/package-release.yml@main
1515
with:
1616
package-name-slug: engineering-platform
17-
package-name-display: Engineering Platform
17+
package-name-display: Kadras Engineering Platform
1818
registry-server: ghcr.io
1919
registry-username: ${{ github.actor }}
2020
image: ${{ github.repository }}
21-
version: 0.14.0
21+
version: 0.15.0
2222
secrets:
2323
pull-request-token: ${{ secrets.GH_ORG_PAT }}

README.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Kadras Engineering Platform
22

3-
![Test Workflow](https://github.com/kadras-io/engineering-platform/actions/workflows/test.yml/badge.svg)
4-
![Release Workflow](https://github.com/kadras-io/engineering-platform/actions/workflows/release.yml/badge.svg)
3+
![Test Workflow](https://github.com/kadras-io/kadras-engineering-platform/actions/workflows/test.yml/badge.svg)
4+
![Release Workflow](https://github.com/kadras-io/kadras-engineering-platform/actions/workflows/release.yml/badge.svg)
55
[![The SLSA Level 3 badge](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev/spec/v1.0/levels)
66
[![The Apache 2.0 license badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
77
[![Follow us on Twitter](https://img.shields.io/static/v1?label=Twitter&message=Follow&color=1DA1F2)](https://twitter.com/kadrasIO)
88

9-
A curated set of Carvel packages to build an engineering platform supporting application developers with paved paths to production on Kubernetes.
9+
A cloud native platform aimed at supporting application developers with paved paths to production on Kubernetes and shipped as a Carvel package.
1010

1111
## 🚀  Getting Started
1212

@@ -28,17 +28,17 @@ Add the Kadras [package repository](https://github.com/kadras-io/kadras-packages
2828
```shell
2929
kctrl package repository add -r kadras-packages \
3030
--url ghcr.io/kadras-io/kadras-packages \
31-
-n kadras-packages --create-namespace
31+
-n kadras-system --create-namespace
3232
```
3333

3434
<details><summary>Installation without package repository</summary>
3535
The recommended way of installing the Engineering Platform package is via the Kadras <a href="https://github.com/kadras-io/kadras-packages">package repository</a>. If you prefer not using the repository, you can add the package definition directly using <a href="https://carvel.dev/kapp/docs/latest/install"><code>kapp</code></a> or <code>kubectl</code>.
3636

3737
```shell
38-
kubectl create namespace kadras-packages
39-
kapp deploy -a engineering-platform-package -n kadras-packages -y \
40-
-f https://github.com/kadras-io/engineering-platform/releases/latest/download/metadata.yml \
41-
-f https://github.com/kadras-io/engineering-platform/releases/latest/download/package.yml
38+
kubectl create namespace kadras-system
39+
kapp deploy -a engineering-platform-package -n kadras-system -y \
40+
-f https://github.com/kadras-io/kadras-engineering-platform/releases/latest/download/metadata.yml \
41+
-f https://github.com/kadras-io/kadras-engineering-platform/releases/latest/download/package.yml
4242
```
4343
</details>
4444

@@ -48,20 +48,20 @@ Install the Engineering Platform package:
4848
kctrl package install -i engineering-platform \
4949
-p engineering-platform.packages.kadras.io \
5050
-v ${VERSION} \
51-
-n kadras-packages
51+
-n kadras-system
5252
```
5353

5454
> **Note**
5555
> You can find the `${VERSION}` value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.
5656
>
5757
> ```shell
58-
> kctrl package available list -p engineering-platform.packages.kadras.io -n kadras-packages
58+
> kctrl package available list -p engineering-platform.packages.kadras.io -n kadras-system
5959
> ```
6060
6161
Verify the installed packages and their status:
6262
6363
```shell
64-
kctrl package installed list -n kadras-packages
64+
kctrl package installed list -n kadras-system
6565
```
6666
6767
## 📙&nbsp; Documentation
@@ -86,7 +86,7 @@ Reference the `values.yml` file from the `kctrl` command when installing or upgr
8686
kctrl package install -i engineering-platform \
8787
-p engineering-platform.packages.kadras.io \
8888
-v ${VERSION} \
89-
-n kadras-packages \
89+
-n kadras-system \
9090
--values-file values.yml
9191
```
9292

@@ -98,9 +98,8 @@ The Engineering Platform package has the following configurable properties.
9898

9999
| Config | Default | Description |
100100
|-------|-------------------|-------------|
101-
| `platform.profile` | `run` | The platform profile to install. Options: `standalone`, `dev`, `build`, `run`. |
102-
| `platform.supply_chain` | `basic` | The type of supply chain to deploy. Options: `basic`, `advanced`. |
103-
| `platform.namespace` | `kadras-packages` | The namespace where to install the platform. |
101+
| `platform.profile` | `run` | The platform profile to install. Options: `standalone`, `build`, `run`. |
102+
| `platform.namespace` | `kadras-system` | The namespace where to install the platform. |
104103
| `platform.excluded_packages` | `[]` | A list of packages to exclude from being installed. |
105104
| `platform.ca_cert_data` | `""` | PEM-encoded certificate data to trust TLS connections with a custom CA. |
106105
| `platform.infrastructure_provider` | `""` | The underlying infrastructure provider. Options are `local` and `vsphere`. This field is not required, but it enables better validation and defaulting if provided. |
@@ -111,29 +110,27 @@ The Engineering Platform package has the following configurable properties.
111110
| `platform.oci_registry.server` | `""` | The server of the OCI Registry where the platform will publish OCI images. Example: "ghcr.io". |
112111
| `platform.oci_registry.repository` | `""` | The repository in the OCI Registry where the platform will publish OCI images. Example: "my-org". |
113112
| `platform.oci_registry.secret.name` | `""` | The name of the Secret holding the credentials to access the OCI registry. The credentials should provide read-only access to the OCI registry except when installing the platform with one of these profiles: `standalone`, `dev`, `build`. |
114-
| `platform.oci_registry.secret.namespace` | `kadras-packages` | The namespace of the Secret holding the credentials to access the OCI registry. |
113+
| `platform.oci_registry.secret.namespace` | `kadras-system` | The namespace of the Secret holding the credentials to access the OCI registry. |
115114
| `platform.cosign.secret.name` | `""` | The name of the Secret holding the Cosign key pair. |
116-
| `platform.cosign.secret.namespace` | `kadras-packages` | The namespace of the Secret holding the Cosign key pair. |
115+
| `platform.cosign.secret.namespace` | `kadras-system` | The namespace of the Secret holding the Cosign key pair. |
117116
| `platform.git.server` | `https://github.com` | The server hosting the Git repositories used by the plaform. |
118117
| `platform.git.secret.name` | `""` | The name of the Secret holding the credentials to access the Git server. The credentials should provide read-only access to the Git server except when installing the platform with one of these profiles: `standalone`, `build`. |
119-
| `platform.git.secret.namespace` | `kadras-packages` | The namespace of the Secret holding the credentials to access the Git server. |
118+
| `platform.git.secret.namespace` | `kadras-system` | The namespace of the Secret holding the credentials to access the Git server. |
120119

121120
Each Kadras package included in the platform can be configured independently.
122121

123122
| Config | Default | Description |
124123
|-------|-------------------|-------------|
125124
| `buildpacks.catalog` | `{}` | Configuration for the Buildpacks Catalog package. |
126125
| `buildpacks.kpack` | `{}` | Configuration for the Kpack package. |
127-
| `cartographer.core` | `{}` | Configuration for the Cartographer Core package including Cartographer and Cartographer Conventions. |
128-
| `cartographer.supply_chains` | `{}` | Configuration for the Cartographer Supply Chains package. |
129126
| `cert_manager.core` | `{}` | Configuration for the Cert Manager package. |
130127
| `cert_manager.issuers` | `{}` | Configuration for the Cert Manager Issuers package. |
131128
| `contour` | `{}` | Configuration for the Contour package. |
132-
| `conventions.spring_boot` | `{}` | Configuration for the Spring Boot Conventions package. |
133129
| `crossplane` | `{}` | Configuration for the Crossplane package. |
134130
| `dapr` | `{}` | Configuration for the Dapr package. |
135131
| `developer_portal` | `{}` | Configuration for the Developer Portal package. |
136132
| `flux` | `{}` | Configuration for the Flux package. |
133+
| `gitops_configurer` | `{}` | Configuration for the GitOps Configurer package. |
137134
| `knative.serving` | `{}` | Configuration for the Knative Serving package. |
138135
| `kyverno.core` | `{}` | Configuration for the Kyverno package. |
139136
| `metrics_server` | `{}` | Configuration for the Metrics Server package. |

docs/quick-start/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ Add the Kadras repository to make the platform packages available to the cluster
5050

5151
```shell
5252
kctrl package repository add -r kadras-packages \
53-
--url ghcr.io/kadras-io/kadras-packages:0.14.2 \
54-
-n kadras-packages --create-namespace
53+
--url ghcr.io/kadras-io/kadras-packages:0.15.0 \
54+
-n kadras-system --create-namespace
5555
```
5656

5757
## Configure the Platform
@@ -75,8 +75,8 @@ Reference the `values.yml` file you created in the previous step and install the
7575
```shell
7676
kctrl package install -i engineering-platform \
7777
-p engineering-platform.packages.kadras.io \
78-
-v 0.12.2 \
79-
-n kadras-packages \
78+
-v 0.17.0 \
79+
-n kadras-system \
8080
--values-file values.yml
8181
```
8282

@@ -85,7 +85,7 @@ Reference the `values.yml` file you created in the previous step and install the
8585
Verify that all the platform components have been installed and properly reconciled.
8686

8787
```shell
88-
kctrl package installed list -n kadras-packages
88+
kctrl package installed list -n kadras-system
8989
```
9090

9191
## Run an Application via CLI

docs/verify-release.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
This package is published as an OCI artifact, signed with Sigstore [Cosign](https://docs.sigstore.dev/cosign/overview), and associated with a [SLSA Provenance](https://slsa.dev/provenance) attestation.
44

5-
Using `cosign`, you can display the supply chain security related artifacts for the `ghcr.io/kadras-io/engineering-platform` images. Use the specific digest you'd like to verify.
5+
Using `cosign`, you can display the supply chain security related artifacts for the `ghcr.io/kadras-io/kadras-engineering-platform` images. Use the specific digest you'd like to verify.
66

77
```shell
8-
cosign tree ghcr.io/kadras-io/engineering-platform
8+
cosign tree ghcr.io/kadras-io/kadras-engineering-platform
99
```
1010

1111
The result:
1212

1313
```shell
14-
📦 Supply Chain Security Related artifacts for an image: ghcr.io/kadras-io/engineering-platform
15-
└── 🔐 Signatures for an image tag: ghcr.io/kadras-io/engineering-platform:sha256-be16d0c9bf7238e991fd7082e4e22707d8969b7904266c2d4476d45fc043555a.sig
14+
📦 Supply Chain Security Related artifacts for an image: ghcr.io/kadras-io/kadras-engineering-platform
15+
└── 🔐 Signatures for an image tag: ghcr.io/kadras-io/kadras-engineering-platform:sha256-be16d0c9bf7238e991fd7082e4e22707d8969b7904266c2d4476d45fc043555a.sig
1616
└── 🍒 sha256:3155f34d804f7c0c1b7067db6b200591835c5612faaa45469952b1bb8ace8f4c
17-
└── 💾 Attestations for an image tag: ghcr.io/kadras-io/engineering-platform:sha256-be16d0c9bf7238e991fd7082e4e22707d8969b7904266c2d4476d45fc043555a.att
17+
└── 💾 Attestations for an image tag: ghcr.io/kadras-io/kadras-engineering-platform:sha256-be16d0c9bf7238e991fd7082e4e22707d8969b7904266c2d4476d45fc043555a.att
1818
└── 🍒 sha256:ce0068e03c1b25884ab7a774408956a930f5c6e087c431ee24f9c692d3c761f5
1919
```
2020

@@ -24,7 +24,7 @@ You can verify the signature and its claims:
2424
cosign verify \
2525
--certificate-identity-regexp https://github.com/kadras-io \
2626
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
27-
ghcr.io/kadras-io/engineering-platform | jq
27+
ghcr.io/kadras-io/kadras-engineering-platform | jq
2828
```
2929

3030
You can also verify the SLSA Provenance attestation associated with the image.
@@ -33,5 +33,5 @@ You can also verify the SLSA Provenance attestation associated with the image.
3333
cosign verify-attestation --type slsaprovenance \
3434
--certificate-identity-regexp https://github.com/slsa-framework \
3535
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
36-
ghcr.io/kadras-io/engineering-platform | jq .payload -r | base64 --decode | jq
36+
ghcr.io/kadras-io/kadras-engineering-platform | jq .payload -r | base64 --decode | jq
3737
```

package/config/components/buildpacks-catalog.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#@ load("@ytt:yaml", "yaml")
44
#@ load("/helpers.star", "is_any_profile_enabled", "is_package_enabled", "profiles")
55

6-
#@ if is_package_enabled("buildpacks-catalog") and is_any_profile_enabled([profiles.standalone, profiles.dev, profiles.build]):
6+
#@ if is_package_enabled("buildpacks-catalog") and is_any_profile_enabled([profiles.standalone, profiles.build]):
77

88
#@ def compute_package_values():
99
#@ values = struct.decode(data.values.buildpacks.catalog)

package/config/components/cartographer-supply-chains.yml

Lines changed: 0 additions & 72 deletions
This file was deleted.

package/config/components/cartographer.yml

Lines changed: 0 additions & 48 deletions
This file was deleted.

package/config/components/cert-manager.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ spec:
2323
packageRef:
2424
refName: cert-manager.packages.kadras.io
2525
versionSelection:
26-
constraints: 1.14.3
26+
constraints: 1.14.4
2727
prereleases: {}
2828
values:
2929
- secretRef:

package/config/components/flux.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,6 @@
77

88
#@ def compute_package_values():
99
#@ values = struct.decode(data.values.flux)
10-
#@
11-
#@ #! Disable Kustomize Controller based on profile
12-
#@ if is_any_profile_enabled([profiles.dev]):
13-
#@ if not hasattr(data.values.flux, "optional_components") or not data.values.flux.optional_components or not hasattr(data.values.flux.optional_components, "kustomize_controller") or not data.values.flux.optional_components.kustomize_controller:
14-
#@ values["optional_components"] = {}
15-
#@ values["optional_components"]["kustomize_controller"] = False
16-
#@ end
17-
#@ end
18-
#@
1910
#@ return struct.encode(values)
2011
#@ end
2112

0 commit comments

Comments
 (0)