-
Notifications
You must be signed in to change notification settings - Fork 18
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
docs: Improve NOTES.txt #269
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice improvement, thanks for having started this PR
|
||
You now have a PolicyServer running in your cluster ready to run any | ||
You now have a default PolicyServer running in your cluster ready to run any |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You now have a default PolicyServer running in your cluster ready to run any | |
You now have a `PolicyServer` resource named `default` running in your cluster. It is ready to run any |
`clusteradmissionpolicies.policies.kubewarden.io` or | ||
`admissionpolicies.policies.kubewarden.io` resources. | ||
|
||
For more information on how to define policies, check out https://kubewarden.io/ | ||
For more information check out https://docs.kubewarden.io/quick-start | ||
For a list of policies, check out https://artifacthub.io/packages/search?kind=13 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discover ready to use policies by visiting https://artifacthub.io/packages/search?kind=13
I think we could leverage
|
f8a262f
to
cafb30c
Compare
Addressed feedback, now it displays: $ helm upgrade -i --wait --namespace kubewarden --create-namespace kubewarden-crds ./charts/kubewarden-crds
Release "kubewarden-crds" has been upgraded. Happy Helming!
NAME: kubewarden-crds
LAST DEPLOYED: Tue Aug 1 12:30:51 2023
NAMESPACE: kubewarden
STATUS: deployed
REVISION: 8
TEST SUITE: None
NOTES:
Kubewarden CRDs now available: `clusteradmissionpolicies.policies.kubewarden.io`,
`admissionpolicies.policies.kubewarden.io`, `policyservers.policies.kubewarden.io`.
Policy report CRDs now available: `policyreports.wgpolicyk8s.io`,
`clusterpolicyreports.wgpolicyk8s.io`.
$ helm upgrade -i --wait --namespace kubewarden --create-namespace kubewarden-controller ./charts/kubewarden-controller
Release "kubewarden-controller" has been upgraded. Happy Helming!
NAME: kubewarden-controller
LAST DEPLOYED: Tue Aug 1 12:15:11 2023
NAMESPACE: kubewarden
STATUS: deployed
REVISION: 4
TEST SUITE: None
NOTES:
You can now start defining admission policies by using the cluster-wide
`clusteradmissionpolicies.policies.kubewarden.io` or the namespaced
`admissionpolicies.policies.kubewarden.io` resources.
For more information check out https://docs.kubewarden.io.
$ helm upgrade -i --wait --namespace kubewarden --create-namespace kubewarden-defaults ./charts/kubewarden-defaults --set recommendedPolicies.enabled=True --set recommendedPolicies.defaultPolicyMode=monitor
Release "kubewarden-defaults" has been upgraded. Happy Helming!
NAME: kubewarden-defaults
LAST DEPLOYED: Tue Aug 1 12:14:19 2023
NAMESPACE: kubewarden
STATUS: deployed
REVISION: 9
TEST SUITE: None
NOTES:
You now have a `PolicyServer` named `default` running in your cluster.
It is ready to run any `clusteradmissionpolicies.policies.kubewarden.io` or
`admissionpolicies.policies.kubewarden.io` resources.
Installed recommended policies:
- no-privilege-escalation
module: kubewarden/policies/allow-privilege-escalation-psp:v0.2.6
- no-host-namespace-sharing
module: kubewarden/policies/host-namespaces-psp:v0.1.6
- no-privileged-pod
module: kubewarden/policies/pod-privileged:v0.2.7
- do-not-run-as-root
module: kubewarden/policies/user-group-psp:v0.4.9
- do-not-share-host-paths
module: kubewarden/policies/hostpaths-psp:v0.1.9
- drop-capabilities
module: kubewarden/policies/capabilities-psp:v0.1.13
For more information check out https://docs.kubewarden.io/quick-start.
Discover ready to use policies at https://artifacthub.io/packages/search?kind=13. |
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice changes
Description
Attempt to improve NOTES.txt that show on installation/upgrade.
While it isn't easy to summarize Kubewarden, we could do better here.
Test
Additional Information
Tradeoff
Potential improvement