Skip to content

Commit

Permalink
docs: Update naming
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasVitale committed Mar 11, 2024
1 parent 9a6485d commit 7481682
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 18 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ assignees: ''
* Kubernetes version (execute `kubectl version`):
* kctrl version (execute `kctrl version`):
* kapp-controller version (execute `kubectl get deployment -n kapp-controller kapp-controller -o yaml` and the annotation is `kbld.k14s.io/images`):
* package version (execute `kctrl package installed get -i workspace-provisioner -n <namespace>`):
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ Add the Kadras [package repository](https://github.com/kadras-io/kadras-packages
```shell
kctrl package repository add -r kadras-packages \
--url ghcr.io/kadras-io/kadras-packages \
-n kadras-packages --create-namespace
-n kadras-system --create-namespace
```

<details><summary>Installation without package repository</summary>
The recommended way of installing the Workspace Provisioner 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>.

```shell
kubectl create namespace kadras-packages
kapp deploy -a workspace-provisioner-package -n kadras-packages -y \
kubectl create namespace kadras-system
kapp deploy -a workspace-provisioner-package -n kadras-system -y \
-f https://github.com/kadras-io/workspace-provisioner/releases/latest/download/metadata.yml \
-f https://github.com/kadras-io/workspace-provisioner/releases/latest/download/package.yml
```
Expand All @@ -52,20 +52,20 @@ Install the Workspace Provisioner package:
kctrl package install -i workspace-provisioner \
-p workspace-provisioner.packages.kadras.io \
-v ${VERSION} \
-n kadras-packages
-n kadras-system
```

> **Note**
> You can find the `${VERSION}` value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.
>
> ```shell
> kctrl package available list -p workspace-provisioner.packages.kadras.io -n kadras-packages
> kctrl package available list -p workspace-provisioner.packages.kadras.io -n kadras-system
> ```
Verify the installed packages and their status:

```shell
kctrl package installed list -n kadras-packages
kctrl package installed list -n kadras-system
```

## 📙&nbsp; Documentation
Expand All @@ -85,7 +85,7 @@ The Workspace Provisioner package can be customized via a `values.yml` file.
oci_registry:
secret:
name: supply-chain-registry-credentials
namespace: kadras-packages
namespace: kadras-system
```

Reference the `values.yml` file from the `kctrl` command when installing or upgrading the package.
Expand All @@ -94,7 +94,7 @@ Reference the `values.yml` file from the `kctrl` command when installing or upgr
kctrl package install -i workspace-provisioner \
-p workspace-provisioner.packages.kadras.io \
-v ${VERSION} \
-n kadras-packages \
-n kadras-system \
--values-file values.yml
```

Expand Down
8 changes: 4 additions & 4 deletions test/integration/default/00-prepare.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
apiVersion: v1
kind: Namespace
metadata:
name: kadras-packages
name: kadras-system

#! OCI Registry

Expand All @@ -12,7 +12,7 @@ apiVersion: v1
kind: Secret
metadata:
name: supply-chain-registry-credentials
namespace: kadras-packages
namespace: kadras-system
type: kubernetes.io/dockerconfigjson
data:
.dockerconfigjson: e30K
Expand All @@ -24,7 +24,7 @@ apiVersion: v1
kind: Secret
metadata:
name: supply-chain-cosign-key-pair
namespace: kadras-packages
namespace: kadras-system
stringData:
cosign.key: key
cosign.password: pass
Expand All @@ -37,7 +37,7 @@ apiVersion: v1
kind: Secret
metadata:
name: supply-chain-git-credentials
namespace: kadras-packages
namespace: kadras-system
stringData:
username: user
password: pass
6 changes: 3 additions & 3 deletions test/integration/default/config/values.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ stringData:
oci_registry:
secret:
name: supply-chain-registry-credentials
namespace: kadras-packages
namespace: kadras-system

cosign:
secret:
name: supply-chain-cosign-key-pair
namespace: kadras-packages
namespace: kadras-system

git:
server: https://github.com
secret:
name: supply-chain-git-credentials
namespace: kadras-packages
namespace: kadras-system
6 changes: 3 additions & 3 deletions test/unit/config/values.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ namespaces:
oci_registry:
secret:
name: supply-chain-registry-credentials
namespace: kadras-packages
namespace: kadras-system

cosign:
secret:
name: supply-chain-cosign-key-pair
namespace: kadras-packages
namespace: kadras-system

git:
server: https://github.com
secret:
name: supply-chain-git-credentials
namespace: kadras-packages
namespace: kadras-system

0 comments on commit 7481682

Please sign in to comment.