Skip to content
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.

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

chore: update README with latest version, example policy topic #32

Merged
merged 1 commit into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
hostLabels:
some-label: value
# Which wasmCloud version to use
version: 0.82.0
version: 1.0.2
# The name of a secret in the same namespace that provides the required secrets.
secretName: cluster-secrets
# Enable the following to run the wasmCloud hosts as a DaemonSet
Expand All @@ -45,12 +45,13 @@ apiVersion: v1
kind: Secret
metadata:
name: my-wasmcloud-cluster
data:
stringData:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this change impact the nats.creds section below?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, removed the base64 bit

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the format of the nats.creds, we should decide if it needs to be nats.creds: | or just base64 encoded string that we could then unpack (I think we should be able to check if it's base64 encoded or not before we store it), wdyt?

Alternatively I suppose we could consider providing an option for secret reference to pull them from, maybe that's a future iteration.

# You can generate this with wash:
# `wash keys gen cluster`
WASMCLOUD_CLUSTER_SEED: <seed>
#data:
# Only required if using a NATS creds file
# nats.creds: <base64 encoded creds file>
# nats.creds: <creds file>
```

The operator will fail to provision the wasmCloud Deployment if any of these
Expand Down Expand Up @@ -100,6 +101,7 @@ config:
```

```sh
helm repo add nats https://nats-io.github.io/k8s/helm/charts/
helm upgrade --install -f values.yaml nats-cluster nats/nats
```

Expand All @@ -118,13 +120,13 @@ wadm:
You can deploy Wadm using your values file and Helm:

```sh
helm install wadm -f values.yaml --version 0.2.0 oci://ghcr.io/wasmcloud/charts/wadm
helm install wadm -f wadm-values.yaml --version 0.2.0 oci://ghcr.io/wasmcloud/charts/wadm
```

### Start the operator

```sh
kubectl kustomize build deploy/local | kubectl apply -f -
kubectl kustomize deploy/base | kubectl apply -f -
```

## Automatically Syncing Kubernetes Services
Expand Down
2 changes: 1 addition & 1 deletion deploy/base/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ spec:
spec:
serviceAccountName: wasmcloud-operator
containers:
- image: ghcr.io/wasmcloud/wasmcloud-operator:0.2.0
- image: ghcr.io/wasmcloud/wasmcloud-operator:0.2.1
imagePullPolicy: Always
name: wasmcloud-operator
ports:
Expand Down
10 changes: 5 additions & 5 deletions sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ spec:
issuers:
- CDKF6OKPOBQKAX57UOXO7SCHURTOZWKWIVPC2HFJTGFXY5VJX44ECEHH
# The lattice to connect the hosts to
lattice: 83a5b52e-17cf-4080-bac8-f844099f142e
lattice: default
# Additional labels to apply to the host other than the defaults set in the controller
hostLabels:
test: value
# Which wasmCloud version to use
version: "1.0.0"
version: "1.0.2"
# The name of a secret in the same namespace that provides the required secrets.
secretName: cluster-secrets
logLevel: INFO
Expand All @@ -27,9 +27,9 @@ spec:
# - "kind-registry:5000"
# Policy service configuration
# policyService:
# topic: "foo"
# changesTopic: "bar"
# timeoutMs: 5000
# topic: "wasmcloud.policy"
# #changesTopic: "bar"
# timeoutMs: 10000
# Additional options to control how the underlying wasmCloud hosts are scheduled in Kubernetes.
# This includes setting resource requirements for the nats and wasmCloud host
# containers along with any additional pot template settings.
Expand Down
Loading