Skip to content

readme: Updated example paths #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MichalTomczakSE wants to merge 4 commits into
base: main
Choose a base branch
from
+12 −12
Open

readme: Updated example paths #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c7e612d
readme: Updated example paths
MichalTomczakSE Nov 11, 2025
efb5d45
docs: bumped provider-version in xpkg install example
MichalTomczakSE Nov 11, 2025
6ce3711
docs: bumped package version in example manifets
MichalTomczakSE Nov 12, 2025
bd4c032
fix: bumped provider version to latest (1.0.4)
MichalTomczakSE Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ so using the Crossplane CLI in a Kubernetes cluster where Crossplane is
installed:

```console
crossplane xpkg install provider xpkg.crossplane.io/crossplane-contrib/provider-helm:v0.20.0
crossplane xpkg install provider xpkg.crossplane.io/crossplane-contrib/provider-helm:v1.0.4
```

Then you will need to create a `ProviderConfig` that specifies the credentials
Expand All @@ -34,27 +34,27 @@ An alternative, that will get you started quickly, is to reuse existing
credentials from within the control plane.

First install `provider-helm` with [additional
configuration](./examples/provider-config/provider-incluster.yaml) to bind its
configuration](./examples/cluster/provider-config/provider-incluster.yaml) to bind its
service account to an existing role in the cluster:

```console
kubectl apply -f ./examples/provider-config/provider-incluster.yaml
kubectl apply -f ./examples/cluster/provider-config/provider-incluster.yaml
```

Then simply create a
[`ProviderConfig`](./examples/provider-config/provider-config-incluster.yaml)
[`ProviderConfig`](./examples/cluster/provider-config/provider-config-incluster.yaml)
that uses an `InjectedIdentity` source:

```console
kubectl apply -f ./examples/provider-config/provider-config-incluster.yaml
kubectl apply -f ./examples/cluster/provider-config/provider-config-incluster.yaml
```

`provider-helm` will then be installed and ready to use within the cluster. You
can now create `Release` resources, such as [sample
release.yaml](examples/sample/release.yaml).
release.yaml](examples/cluster/sample/release.yaml).

```console
kubectl create -f examples/sample/release.yaml
kubectl create -f examples/cluster/sample/release.yaml
```

## Design
Expand Down Expand Up @@ -86,12 +86,12 @@ using `kind` for local development):
```console
KUBECONFIG=$(kind get kubeconfig | sed -e 's|server:\s*.*$|server: http://localhost:8081|g')
kubectl -n crossplane-system create secret generic cluster-config --from-literal=kubeconfig="${KUBECONFIG}"
kubectl apply -f examples/provider-config/provider-config-with-secret.yaml
kubectl apply -f examples/cluster/provider-config/provider-config-with-secret.yaml
```

Now you can create `Release` resources with this `ProviderConfig`, for example
[sample release.yaml](examples/sample/release.yaml).
[sample release.yaml](examples/cluster/sample/release.yaml).

```console
kubectl create -f examples/sample/release.yaml
kubectl create -f examples/cluster/sample/release.yaml
```
2 changes: 1 addition & 1 deletion examples/cluster/provider-config/provider-incluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: Provider
metadata:
name: provider-helm
spec:
package: xpkg.crossplane.io/crossplane-contrib/provider-helm:v1.0.0
package: xpkg.crossplane.io/crossplane-contrib/provider-helm:v1.0.4
runtimeConfigRef:
apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
Expand Down
2 changes: 1 addition & 1 deletion examples/namespaced/provider-config/provider-incluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: Provider
metadata:
name: provider-helm
spec:
package: xpkg.crossplane.io/crossplane-contrib/provider-helm:v1.0.0
package: xpkg.crossplane.io/crossplane-contrib/provider-helm:v1.0.4
runtimeConfigRef:
apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
Expand Down