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

docs: Improve NOTES.txt #269

Merged
merged 1 commit into from
Aug 1, 2023
Merged

docs: Improve NOTES.txt #269

merged 1 commit into from
Aug 1, 2023

Conversation

viccuad
Copy link
Member

@viccuad viccuad commented Jul 31, 2023

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

@viccuad viccuad self-assigned this Jul 31, 2023
@viccuad viccuad requested a review from a team as a code owner July 31, 2023 08:42
Copy link
Member

@flavio flavio left a 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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Member

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

@olblak
Copy link
Member

olblak commented Jul 31, 2023

I think we could leverage if statement in the NOTE.txt such as

kubewarden-defaults installed.

You now have a PolicyServer running in your cluster 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/

{{ if .Values.recommendedPolicies }}

Installed recommended policies
* kubewarden/policies/allow-privilege-escalation-psp
-> https://artifacthub.io/packages/kubewarden/allow-privilege-escalation-psp/allow-privilege-escalation-psp
* kubewarden/policies/host-namespaces-psp
-> https://artifacthub.io/packages/kubewarden/host-namespaces-psp/host-namespaces-psp
* kubewarden/policies/pod-privileged
-> https://artifacthub.io/packages/kubewarden/pod-privileged-policy/pod-privileged-policy
* kubewarden/policies/user-group-psp
-> https://artifacthub.io/packages/kubewarden/user-group-psp/user-group-psp
* kubewarden/policies/hostpaths-psp
-> https://artifacthub.io/packages/kubewarden/hostpaths-psp/hostpaths-psp
* kubewarden/policies/capabilities-psp
-> https://artifacthub.io/packages/kubewarden/capabilities-psp/capabilities-psp

{{- end }}

@viccuad viccuad force-pushed the improve-notes branch 2 times, most recently from f8a262f to cafb30c Compare August 1, 2023 10:17
@viccuad
Copy link
Member Author

viccuad commented Aug 1, 2023

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]>
Copy link
Member

@flavio flavio left a comment

Choose a reason for hiding this comment

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

nice changes

@jvanz jvanz merged commit 7dec9a7 into kubewarden:main Aug 1, 2023
2 of 3 checks passed
@viccuad viccuad deleted the improve-notes branch August 1, 2023 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants