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

Learning paths #425

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
5 changes: 5 additions & 0 deletions docs/learnpaths/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Learning paths",
"position": 25,
"collapsed": true
}
17 changes: 17 additions & 0 deletions docs/learnpaths/kubewarden-all.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: All
sidebar_position: 70
title: All
description: Learning path for All.
keywords: [learning path]
doc-persona: [kubewarden-all]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Explanation</strong><br/><br/>/explanations/comparisons|kubewarden,<br/>kubernetes,<br/>opa gatekeeper,<br/>comparison|A brief comparison of the difference between Kubewarden and OPA Gatekeeper.<br/>[Kubewarden vs OPA Gatekeeper](../explanations/comparisons/opa-comparison.md)|
|<strong>Explanation</strong><br/><br/>/explanations|kubewarden,<br/>kubernetes,<br/>architecture|The Kubewarden architecture<br/>[Kubewarden architecture](../explanations/architecture.md)|
|<strong>Howto</strong><br/><br/>/howtos|kubewarden,<br/>kubernetes,<br/>kwctl,<br/>policy,<br/>policyserver,<br/>clusteradmissionpolicy,<br/>admissionpolicy|Description of some common tasks undertaken after installing Kubewarden. Provides examples of these tasks using kwctl<br/>[Common tasks](../howtos/tasks.md)|
|<strong>Reference</strong><br/><br/>/reference|dependency,<br/>dependencies,<br/>CRD,<br/>charts,<br/>matrix|Dependency matrix of Kubewarden.<br/>[Dependency matrix](../reference/dependency-matrix.md)|
21 changes: 21 additions & 0 deletions docs/learnpaths/kubewarden-developer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_label: Developer
sidebar_position: 60
title: Developer
description: Learning path for Developer.
keywords: [learning path]
doc-persona: [kubewarden-developer]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Tutorial</strong><br/><br/>/tutorials/testing-policies|kubewarden,<br/>kubernetes,<br/>cluster operators,<br/>testing|An introduction to testing Kubewarden policies for cluster operators.<br/>[Testing for cluster operators](../tutorials/testing-policies/03-cluster-operators.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/go|kubewarden,<br/>kubernetes,<br/>writing policies,<br/>raw,<br/>go|Writing raw Kubewarden policies using Go.<br/>[Writing raw policies](../tutorials/writing-policies/go/10-raw-policies.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies|kubewarden,<br/>kubernetes,<br/>typescript|Writing Kubewarden policies with Typescript<br/>[Typescript](../tutorials/writing-policies/typescript.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/rust|kubewarden,<br/>kubernetes,<br/>raw policies,<br/>rust|Kubewarden support for raw policies using Rust.<br/>[Raw policies](../tutorials/writing-policies/rust/08-raw-policies.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/wasi|kubewarden,<br/>kubernetes,<br/>raw policies|Using Kubewarden for writing raw policies.<br/>[Writing raw policies](../tutorials/writing-policies/wasi/02-raw-policies.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/CEL|kubewarden,<br/>kubernetes,<br/>writing policies,<br/>sigstore,<br/>signature,<br/>verification|Example: Sigstore CEL policy<br/>[Sigstore host capabilities](../tutorials/writing-policies/CEL/04-example-sigstore.md)|
|<strong>Howto</strong><br/><br/>/howtos/contribution-guide|kubewarden,<br/>documentation,<br/>suggesting an improvement|Suggesting a doc improvement.<br/>[Suggesting a doc improvement](../howtos/contribution-guide/suggesting-an-improvement.md)|
|<strong>Reference</strong><br/><br/>/reference|kubewarden,<br/>kubernetes,<br/>custom resource definitions,<br/>crd|Kubewarden's Custom Resource Definitions (CRD)<br/>[Custom Resource Definitions (CRD)](../reference/CRDs.md)|
17 changes: 17 additions & 0 deletions docs/learnpaths/kubewarden-distributor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: Distributor
sidebar_position: 40
title: Distributor
description: Learning path for Distributor.
keywords: [learning path]
doc-persona: [kubewarden-distributor]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Tutorial</strong><br/><br/>/tutorials|kubewarden,<br/>kubernetes,<br/>publishing policies,<br/>artifact hub|A brief introduction to publishing Kubewarden policies on Artifact Hub.<br/>[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub.md)|
|<strong>Explanation</strong><br/><br/>/explanations|oci,<br/>kubewarden,<br/>policy,<br/>wasm,<br/>webassembly|A description of how Kubewarden policies are distributed from OCI-compliant repositories.<br/>[Distributing policies](../explanations/distributing-policies.md)|
|<strong>Howto</strong><br/><br/>/howtos|kubewarden,<br/>kubernetes,<br/>cel,<br/>vap,<br/>validatingadmissionpolicy|Discusses how to migrate from Kubernetes VAP policies to Kubewarden.<br/>[ValidatingAdmissionPolicy migration](../howtos/vap-migration.md)|
|<strong>Howto</strong><br/><br/>/howtos/workarounds|kubewarden,<br/>kubernetes,<br/>policy server certificates|How-to work around Policy Server certificate expiry issue<br/>[Policy Server certificate rotation issue](../howtos/workarounds/policy-server-certificate-expiry.md)|
24 changes: 24 additions & 0 deletions docs/learnpaths/kubewarden-integrator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_label: Integrator
sidebar_position: 50
title: Integrator
description: Learning path for Integrator.
keywords: [learning path]
doc-persona: [kubewarden-integrator]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Tutorial</strong><br/><br/>/tutorials|kubewarden,<br/>kubernetes,<br/>security,<br/>verification|Verifying Kubewarden.<br/>[Verifying Kubewarden](../tutorials/verifying-kubewarden.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/rust|kubewarden,<br/>kubernetes,<br/>raw policies,<br/>rust|Kubewarden support for raw policies using Rust.<br/>[Raw policies](../tutorials/writing-policies/rust/08-raw-policies.md)|
|<strong>Explanation</strong><br/><br/>/explanations/audit-scanner|kubewarden,<br/>kubernetes,<br/>audit scanner|The policy reports that the Audit Scanner produces.<br/>[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports.md)|
|<strong>Explanation</strong><br/><br/>/explanations|kubewarden,<br/>policy mutating,<br/>kubernetes,<br/>clusteradmissionpolicy,<br/>admissionpolicy|Explains mutating policies in the context of Kubewarden<br/>[Mutating policies](../explanations/mutating-policies.md)|
|<strong>Howto</strong><br/><br/>/howtos|kubewarden,<br/>kubernetes,<br/>cel,<br/>vap,<br/>validatingadmissionpolicy|Discusses how to migrate from Kubernetes VAP policies to Kubewarden.<br/>[ValidatingAdmissionPolicy migration](../howtos/vap-migration.md)|
|<strong>Howto</strong><br/><br/>/howtos/airgap|kubewarden,<br/>kubernetes,<br/>air gap installation|Air gap installation for Kubewarden.<br/>[Air gap installation](../howtos/airgap/02-install.md)|
|<strong>Howto</strong><br/><br/>/howtos/policy-servers|kubewarden,<br/>kubernetes,<br/>policyservers,<br/>production,<br/>poddisruptionbudget,<br/>affinity,<br/>limits|Configuring PolicyServers for production<br/>[Configuring PolicyServers for production](../howtos/policy-servers/03-production-deployments.md)|
|<strong>Howto</strong><br/><br/>/howtos/telemetry|kubewarden,<br/>kubernetes,<br/>opentelemetry,<br/>open telemetry,<br/>quickstart|An Open Telemetry quickstart for Kubewarden.<br/>[Open Telemetry quick start](../howtos/telemetry/10-opentelemetry-qs.md)|
|<strong>Hosto</strong><br/><br/>/howtos/ui-extension|kubewarden,<br/>kubernetes,<br/>tracing|Tracing for Kubewarden.<br/>[Tracing](../howtos/ui-extension/03-tracing.md)|
|<strong>Howto</strong><br/><br/>/howtos/workarounds|kubewarden,<br/>kubernetes,<br/>policy server certificates|How-to work around Policy Server certificate expiry issue<br/>[Policy Server certificate rotation issue](../howtos/workarounds/policy-server-certificate-expiry.md)|
|<strong>Reference</strong><br/><br/>/reference|kubewarden,<br/>kubernetes,<br/>sources.yaml|Reference for sources.yaml<br/>[Reference for sources.yaml](../reference/sources_yaml.md)|
27 changes: 27 additions & 0 deletions docs/learnpaths/kubewarden-operator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_label: Operator
sidebar_position: 20
title: Operator
description: Learning path for Operator.
keywords: [learning path]
doc-persona: [kubewarden-operator]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Tutorial</strong><br/><br/>/tutorials|kubewarden,<br/>kubernetes,<br/>security,<br/>verification|Verifying Kubewarden.<br/>[Verifying Kubewarden](../tutorials/verifying-kubewarden.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/testing-policies|kubewarden,<br/>persons,<br/>policy author,<br/>cluster operator|A tutorial about testing policies in Kubewarden.<br/>[Policy testing](../tutorials/testing-policies/index.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/go|kubewarden,<br/>kubernetes,<br/>distributing kubewarden policies|Distributing Kubewarden policies developed with Go.<br/>[Distributing policy](../tutorials/writing-policies/go/08-distribute.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/rust|kubewarden,<br/>kubernetes,<br/>writing policies,<br/>rust,<br/>build and distribute|Building and distributing Kubewarden policies developed with Rust.<br/>[Building and distributing policies](../tutorials/writing-policies/rust/07-build-and-distribute.md)|
|<strong>Explanation</strong><br/><br/>/explanations/audit-scanner|kubewarden,<br/>kubernetes,<br/>audit scanner|The policy reports that the Audit Scanner produces.<br/>[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports.md)|
|<strong>Explanation</strong><br/><br/>/explanations|oci,<br/>kubewarden,<br/>policy,<br/>wasm,<br/>webassembly|A description of how Kubewarden policies are distributed from OCI-compliant repositories.<br/>[Distributing policies](../explanations/distributing-policies.md)|
|<strong>Howto</strong><br/><br/>/howtos|kubewarden,<br/>kubernetes,<br/>cel,<br/>vap,<br/>validatingadmissionpolicy|Discusses how to migrate from Kubernetes VAP policies to Kubewarden.<br/>[ValidatingAdmissionPolicy migration](../howtos/vap-migration.md)|
|<strong>Howto</strong><br/><br/>/howtos/airgap|kubewarden,<br/>kubernetes,<br/>air gap installation|Air gap installation for Kubewarden.<br/>[Air gap installation](../howtos/airgap/02-install.md)|
|<strong>Howto</strong><br/><br/>/howtos/contribution-guide|kubewarden,<br/>documentation,<br/>suggesting an improvement|Suggesting a doc improvement.<br/>[Suggesting a doc improvement](../howtos/contribution-guide/suggesting-an-improvement.md)|
|<strong>Howto</strong><br/><br/>/howtos/policy-servers|kubewarden,<br/>kubernetes,<br/>policyservers,<br/>production,<br/>poddisruptionbudget,<br/>affinity,<br/>limits|Configuring PolicyServers for production<br/>[Configuring PolicyServers for production](../howtos/policy-servers/03-production-deployments.md)|
|<strong>Howto</strong><br/><br/>/howtos/telemetry|kubewarden,<br/>kubernetes,<br/>opentelemetry,<br/>open telemetry,<br/>quickstart|An Open Telemetry quickstart for Kubewarden.<br/>[Open Telemetry quick start](../howtos/telemetry/10-opentelemetry-qs.md)|
|<strong>Hosto</strong><br/><br/>/howtos/ui-extension|kubewarden,<br/>kubernetes,<br/>tracing|Tracing for Kubewarden.<br/>[Tracing](../howtos/ui-extension/03-tracing.md)|
|<strong>Howto</strong><br/><br/>/howtos/workarounds|kubewarden,<br/>kubernetes,<br/>policy server certificates|How-to work around Policy Server certificate expiry issue<br/>[Policy Server certificate rotation issue](../howtos/workarounds/policy-server-certificate-expiry.md)|
|<strong>Reference</strong><br/><br/>/reference|kubewarden,<br/>kubernetes,<br/>sources.yaml|Reference for sources.yaml<br/>[Reference for sources.yaml](../reference/sources_yaml.md)|
24 changes: 24 additions & 0 deletions docs/learnpaths/kubewarden-policy-developer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_label: Policy developer
sidebar_position: 40
title: Policy developer
description: Learning path for Policy developer.
keywords: [learning path]
doc-persona: [kubewarden-policy-developer]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Tutorial</strong><br/><br/>/tutorials|kubewarden,<br/>kubernetes,<br/>security,<br/>verification|Verifying Kubewarden.<br/>[Verifying Kubewarden](../tutorials/verifying-kubewarden.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/testing-policies|kubewarden,<br/>persons,<br/>policy author,<br/>cluster operator|A tutorial about testing policies in Kubewarden.<br/>[Policy testing](../tutorials/testing-policies/index.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies|kubewarden,<br/>kubernetes,<br/>writing policies,<br/>swift|Kubewarden policies with Swift<br/>[Swift](../tutorials/writing-policies/swift.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/rego|kubewarden,<br/>kubernetes,<br/>builtin wasm support|The Kubewarden provided support for executing wasm binaries.<br/>[Builtin support](../tutorials/writing-policies/rego/02-builtin-support.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/rego/gatekeeper|kubewarden,<br/>kubernetes,<br/>gatekeeper,<br/>rego|Distributing a Gatekeeper policy with Kubewarden.<br/>[Distributing a Gatekeeper policy with Kubewarden](../tutorials/writing-policies/rego/gatekeeper/04-distribute.md)|
|<strong>Tutorial</strong><br/><br/>/tutorials/writing-policies/rego/open-policy-agent|kubewarden,<br/>kubernetes,<br/>raw policies,<br/>open policy agent,<br/>opa,<br/>rego|Writing raw OPA policies for Kubewarden.<br/>[Writing raw policies](../tutorials/writing-policies/rego/open-policy-agent/05-raw-policies.md)|
|<strong>Explanation</strong><br/><br/>/explanations/audit-scanner|kubewarden,<br/>kubernetes,<br/>audit scanner|The policy reports that the Audit Scanner produces.<br/>[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports.md)|
|<strong>Explanation</strong><br/><br/>/explanations|kubewarden,<br/>policy mutating,<br/>kubernetes,<br/>clusteradmissionpolicy,<br/>admissionpolicy|Explains mutating policies in the context of Kubewarden<br/>[Mutating policies](../explanations/mutating-policies.md)|
|<strong>Howto</strong><br/><br/>/howtos|kubewarden,<br/>kubernetes,<br/>support,<br/>raw policies|Kubewarden support for 'raw' policies.<br/>[Raw policies](../howtos/raw-policies.md)|
|<strong>Reference</strong><br/><br/>/reference/spec|kubewarden,<br/>kubernetes,<br/>policy specification,<br/>context aware policies|Context aware policies.<br/>[Context aware policies](../reference/spec/05-context-aware-policies.md)|
|<strong>Reference</strong><br/><br/>/reference/spec/host-capabilities|kubewarden,<br/>kubernetes,<br/>policy specification,<br/>registry capabilities|Container registry capabilities.<br/>[Container registry capabilities](../reference/spec/host-capabilities/03-container-registry.md)|
17 changes: 17 additions & 0 deletions docs/learnpaths/kubewarden-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: Policy user
sidebar_position: 10
title: Policy user
description: Learning path for Policy user.
keywords: [learning path]
doc-persona: [kubewarden-user]
doc-type: [explanation]
doc-topic: [learning-path]
---

|Type & Location|Keywords|Description & Title|
|-|-|-|
|<strong>Tutorial</strong><br/><br/>/tutorials|kubewarden,<br/>kubernetes,<br/>publishing policies,<br/>artifact hub|A brief introduction to publishing Kubewarden policies on Artifact Hub.<br/>[Publish policies to Artifact Hub](../tutorials/publish-policy-to-artifact-hub.md)|
|<strong>Explanation</strong><br/><br/>/explanations/audit-scanner|kubewarden,<br/>kubernetes,<br/>audit scanner|The policy reports that the Audit Scanner produces.<br/>[Audit Scanner - Policy Reports](../explanations/audit-scanner/policy-reports.md)|
|<strong>Howto</strong><br/><br/>/howtos|kubewarden,<br/>kubernetes,<br/>cel,<br/>vap,<br/>validatingadmissionpolicy|Discusses how to migrate from Kubernetes VAP policies to Kubewarden.<br/>[ValidatingAdmissionPolicy migration](../howtos/vap-migration.md)|
|<strong>Reference</strong><br/><br/>/reference|kubernetes,<br/>kubewarden,<br/>monitor mode|The Kubewarden monitor mode and how to activate it.<br/>[Monitor mode](../reference/monitor-mode.md)|
26 changes: 26 additions & 0 deletions docs/learnpaths/paths.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_label: Introduction
sidebar_position: 5
title: Introduction
description: Learning paths for different personas.
keywords: [learning paths]
doc-persona: [kubewarden-all]
doc-type: [explanation]
doc-topic: [learning-paths]
---

<head>
<link rel="canonical" href="https://docs.kubewarden.io/learning-paths/paths"/>
</head>

If you are new to Kubewarden, these sections contain a set of learning paths for different personas.

|Persona|Description|
jhkrug marked this conversation as resolved.
Show resolved Hide resolved
|-|-|
|[Policy user](kubewarden-user.md)|Someone who takes a policy and uses it in a cluster. They deploy policies and observe results.|
|[Operator](kubewarden-operator.md)|Someone operating Kubewarden in a cluster. Installs and maintains Kubewarden.|
|[Distributor](kubewarden-distributor.md)|Someone who has written a policy and wants to share it with others. They want the policy to be easily consumed by the “policy consumer” role. A distributor of Kubewarden policies, to places such as ArtifactHub.|
|[Policy developer](kubewarden-policy-developer.md)| A person designing policies for Kubewarden and specifying their configuration.|
|[Integrator](kubewarden-integrator.md)|Builds with, using, or on top of KW. Perhaps a custom UI or a helper tool for generating policies.|
|[Developer](kubewarden-developer.md)|A person working on the Kubewarden product set. Building Kubewarden itself.|
|[All](kubewarden-all.md)|Documentation sections of common interest.|
Loading