From 0eac6533e77baf34673417fc9e491489db11ebda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Cuadrado=20Juan?= Date: Mon, 31 Jul 2023 10:34:42 +0200 Subject: [PATCH] docs: Improve NOTES.txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Víctor Cuadrado Juan --- .../kubewarden-controller/templates/NOTES.txt | 6 ++--- charts/kubewarden-crds/templates/NOTES.txt | 6 +++++ .../kubewarden-defaults/templates/NOTES.txt | 24 +++++++++++++++---- 3 files changed, 27 insertions(+), 9 deletions(-) create mode 100644 charts/kubewarden-crds/templates/NOTES.txt diff --git a/charts/kubewarden-controller/templates/NOTES.txt b/charts/kubewarden-controller/templates/NOTES.txt index 83acaaae..17dfb266 100644 --- a/charts/kubewarden-controller/templates/NOTES.txt +++ b/charts/kubewarden-controller/templates/NOTES.txt @@ -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. diff --git a/charts/kubewarden-crds/templates/NOTES.txt b/charts/kubewarden-crds/templates/NOTES.txt new file mode 100644 index 00000000..c4ef0d4e --- /dev/null +++ b/charts/kubewarden-crds/templates/NOTES.txt @@ -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 }} diff --git a/charts/kubewarden-defaults/templates/NOTES.txt b/charts/kubewarden-defaults/templates/NOTES.txt index 82833b8f..6b4fe8fe 100644 --- a/charts/kubewarden-defaults/templates/NOTES.txt +++ b/charts/kubewarden-defaults/templates/NOTES.txt @@ -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.