Skip to content

Commit 7481682

Browse files
committed
docs: Update naming
1 parent 9a6485d commit 7481682

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ assignees: ''
2424
* Kubernetes version (execute `kubectl version`):
2525
* kctrl version (execute `kctrl version`):
2626
* kapp-controller version (execute `kubectl get deployment -n kapp-controller kapp-controller -o yaml` and the annotation is `kbld.k14s.io/images`):
27+
* package version (execute `kctrl package installed get -i workspace-provisioner -n <namespace>`):

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ Add the Kadras [package repository](https://github.com/kadras-io/kadras-packages
3232
```shell
3333
kctrl package repository add -r kadras-packages \
3434
--url ghcr.io/kadras-io/kadras-packages \
35-
-n kadras-packages --create-namespace
35+
-n kadras-system --create-namespace
3636
```
3737

3838
<details><summary>Installation without package repository</summary>
3939
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>.
4040

4141
```shell
42-
kubectl create namespace kadras-packages
43-
kapp deploy -a workspace-provisioner-package -n kadras-packages -y \
42+
kubectl create namespace kadras-system
43+
kapp deploy -a workspace-provisioner-package -n kadras-system -y \
4444
-f https://github.com/kadras-io/workspace-provisioner/releases/latest/download/metadata.yml \
4545
-f https://github.com/kadras-io/workspace-provisioner/releases/latest/download/package.yml
4646
```
@@ -52,20 +52,20 @@ Install the Workspace Provisioner package:
5252
kctrl package install -i workspace-provisioner \
5353
-p workspace-provisioner.packages.kadras.io \
5454
-v ${VERSION} \
55-
-n kadras-packages
55+
-n kadras-system
5656
```
5757

5858
> **Note**
5959
> You can find the `${VERSION}` value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.
6060
>
6161
> ```shell
62-
> kctrl package available list -p workspace-provisioner.packages.kadras.io -n kadras-packages
62+
> kctrl package available list -p workspace-provisioner.packages.kadras.io -n kadras-system
6363
> ```
6464
6565
Verify the installed packages and their status:
6666
6767
```shell
68-
kctrl package installed list -n kadras-packages
68+
kctrl package installed list -n kadras-system
6969
```
7070
7171
## 📙&nbsp; Documentation
@@ -85,7 +85,7 @@ The Workspace Provisioner package can be customized via a `values.yml` file.
8585
oci_registry:
8686
secret:
8787
name: supply-chain-registry-credentials
88-
namespace: kadras-packages
88+
namespace: kadras-system
8989
```
9090
9191
Reference the `values.yml` file from the `kctrl` command when installing or upgrading the package.
@@ -94,7 +94,7 @@ Reference the `values.yml` file from the `kctrl` command when installing or upgr
9494
kctrl package install -i workspace-provisioner \
9595
-p workspace-provisioner.packages.kadras.io \
9696
-v ${VERSION} \
97-
-n kadras-packages \
97+
-n kadras-system \
9898
--values-file values.yml
9999
```
100100

test/integration/default/00-prepare.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
apiVersion: v1
44
kind: Namespace
55
metadata:
6-
name: kadras-packages
6+
name: kadras-system
77

88
#! OCI Registry
99

@@ -12,7 +12,7 @@ apiVersion: v1
1212
kind: Secret
1313
metadata:
1414
name: supply-chain-registry-credentials
15-
namespace: kadras-packages
15+
namespace: kadras-system
1616
type: kubernetes.io/dockerconfigjson
1717
data:
1818
.dockerconfigjson: e30K
@@ -24,7 +24,7 @@ apiVersion: v1
2424
kind: Secret
2525
metadata:
2626
name: supply-chain-cosign-key-pair
27-
namespace: kadras-packages
27+
namespace: kadras-system
2828
stringData:
2929
cosign.key: key
3030
cosign.password: pass
@@ -37,7 +37,7 @@ apiVersion: v1
3737
kind: Secret
3838
metadata:
3939
name: supply-chain-git-credentials
40-
namespace: kadras-packages
40+
namespace: kadras-system
4141
stringData:
4242
username: user
4343
password: pass

test/integration/default/config/values.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ stringData:
1212
oci_registry:
1313
secret:
1414
name: supply-chain-registry-credentials
15-
namespace: kadras-packages
15+
namespace: kadras-system
1616

1717
cosign:
1818
secret:
1919
name: supply-chain-cosign-key-pair
20-
namespace: kadras-packages
20+
namespace: kadras-system
2121

2222
git:
2323
server: https://github.com
2424
secret:
2525
name: supply-chain-git-credentials
26-
namespace: kadras-packages
26+
namespace: kadras-system

test/unit/config/values.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ namespaces:
77
oci_registry:
88
secret:
99
name: supply-chain-registry-credentials
10-
namespace: kadras-packages
10+
namespace: kadras-system
1111

1212
cosign:
1313
secret:
1414
name: supply-chain-cosign-key-pair
15-
namespace: kadras-packages
15+
namespace: kadras-system
1616

1717
git:
1818
server: https://github.com
1919
secret:
2020
name: supply-chain-git-credentials
21-
namespace: kadras-packages
21+
namespace: kadras-system

0 commit comments

Comments
 (0)