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

Conversation

protochron
Copy link
Contributor

Feature or Problem

See title

Related Issues

Release Information

Consumer Impact

Testing

Unit Test(s)

Acceptance or Integration

Manual Verification

@protochron protochron requested a review from joonas May 10, 2024 16:12
Copy link

github-actions bot commented May 10, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

@@ -45,7 +45,7 @@ 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.

README.md Outdated
```

### Start the operator

```sh
kubectl kustomize build deploy/local | kubectl apply -f -
kubectl kustomize deploy/local | kubectl apply -f -
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if this is intended for running it locally vs. "production", but if it's the latter, should this reference the helm chart instead of kustomize?

I know there's a philosophical debate about this that could be had, but kustomize feels more appropriate for local development vs. helm for production.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It should be base actually, not local. I'll fix that

@@ -45,7 +45,7 @@ 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.

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.

Signed-off-by: Dan Norris <protochron@users.noreply.github.com>
@protochron protochron merged commit 35af8ad into main May 10, 2024
3 checks passed
@protochron protochron deleted the update_readme branch May 10, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants