Skip to content

Commit

Permalink
docs: Improve NOTES.txt
Browse files Browse the repository at this point in the history
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
  • Loading branch information
viccuad committed Aug 1, 2023
1 parent a080317 commit 0eac653
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 9 deletions.
6 changes: 2 additions & 4 deletions charts/kubewarden-controller/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
kubewarden-controller installed.

You can start defining admission policies by using the cluster-wide
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://kubewarden.io/
For more information check out https://docs.kubewarden.io.
6 changes: 6 additions & 0 deletions charts/kubewarden-crds/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Kubewarden CRDs now available: `clusteradmissionpolicies.policies.kubewarden.io`,
`admissionpolicies.policies.kubewarden.io`, `policyservers.policies.kubewarden.io`.
{{ if .Values.installPolicyReportCRDs }}
Policy report CRDs now available: `policyreports.wgpolicyk8s.io`,
`clusterpolicyreports.wgpolicyk8s.io`.
{{- end }}
24 changes: 19 additions & 5 deletions charts/kubewarden-defaults/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
kubewarden-defaults installed.

You now have a PolicyServer running in your cluster ready to run any
`clusteradmissionpolicies.policies.kubewarden.io` or
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.
{{ if .Values.recommendedPolicies }}
Installed recommended policies:
- {{ .Values.recommendedPolicies.allowPrivilegeEscalationPolicy.name }}
module: {{ .Values.recommendedPolicies.allowPrivilegeEscalationPolicy.module }}
- {{ .Values.recommendedPolicies.hostNamespacePolicy.name }}
module: {{ .Values.recommendedPolicies.hostNamespacePolicy.module }}
- {{ .Values.recommendedPolicies.podPrivilegedPolicy.name }}
module: {{ .Values.recommendedPolicies.podPrivilegedPolicy.module }}
- {{ .Values.recommendedPolicies.userGroupPolicy.name }}
module: {{ .Values.recommendedPolicies.userGroupPolicy.module }}
- {{ .Values.recommendedPolicies.hostPathsPolicy.name }}
module: {{ .Values.recommendedPolicies.hostPathsPolicy.module }}
- {{ .Values.recommendedPolicies.capabilitiesPolicy.name }}
module: {{ .Values.recommendedPolicies.capabilitiesPolicy.module }}
{{- end }}

For more information on how to define policies, check out https://kubewarden.io/
For more information check out https://docs.kubewarden.io/quick-start.
Discover ready to use policies at https://artifacthub.io/packages/search?kind=13.

0 comments on commit 0eac653

Please sign in to comment.