quick-start -> quickstart

add redirects from old paths remove npm package-lock.json update getting started re-order tutorials in quickstart by area (put network policy tutorials together)
otterize · Sep 20, 2023 · 921d138 · 921d138
1 parent 8121442
commit 921d138
Show file tree

Hide file tree

Showing 24 changed files with 390 additions and 13,633 deletions.
diff --git a/docs/faq/README.mdx b/docs/faq/README.mdx
@@ -87,7 +87,7 @@ to integrate with your infrastructure, e.g. for integrating with Kafka outside o
 
 Sure, in fact we recommend that you roll out IBAC gradually, to grow your and your organization's confidence in this approach.
 Change, even when positive, is not always easy to manage. Tools such as the network mapper let you bootstrap intents files to make
-adoption by teams that own specific services much easier. Read the various tutorials for [network policies](/quick-start/access-control/k8s-network-policies), [Kafka](/quick-start/access-control/k8s-kafka-mtls), [network mapping](/quick-start/visualization/k8s-network-mapper), and [mTLS](/quick-start/access-control/k8s-mtls)
+adoption by teams that own specific services much easier. Read the various tutorials for [network policies](/quickstart/access-control/k8s-network-policies), [Kafka](/quickstart/access-control/k8s-kafka-mtls), [network mapping](/quickstart/visualization/k8s-network-mapper), and [mTLS](/quickstart/access-control/k8s-mtls)
 to see how to roll out IBAC gradually for various use cases.
 
 </details>
@@ -98,7 +98,7 @@ to see how to roll out IBAC gradually for various use cases.
 
 Otterize's approach is to configure and use your existing infrastructure as much as possible, rather than replacing existing components, and help you achieve zero-trust through effective use of authentication and authorization across heterogeneous infrastructures and tech stacks. The drivers for authentication and authorization are client intents: metadata that's used to configure enforcement points.
 
-In contrast, service meshes aim to solve a whole slew of problems and tasks related to microservices, such as request routing and load balancing, circuit breaking, retries, rate limiting, blue/green deployment, service discovery, observability and metrics, as well as authentication and authorization. Otterize does not aim to do all of these things &mdash; only authentication and authorization. And even there, it does not aim to replace enforcement points for authN/authZ &mdash; it just configures them based on client intents and any overriding rules. So if a service mesh is used to enforce access, Otterize would configure it based on client intents (and any override rules) &mdash; as we do with [our support for Istio](/quick-start/access-control/k8s-istio-authorization-policies).
+In contrast, service meshes aim to solve a whole slew of problems and tasks related to microservices, such as request routing and load balancing, circuit breaking, retries, rate limiting, blue/green deployment, service discovery, observability and metrics, as well as authentication and authorization. Otterize does not aim to do all of these things &mdash; only authentication and authorization. And even there, it does not aim to replace enforcement points for authN/authZ &mdash; it just configures them based on client intents and any overriding rules. So if a service mesh is used to enforce access, Otterize would configure it based on client intents (and any override rules) &mdash; as we do with [our support for Istio](/quickstart/access-control/k8s-istio-authorization-policies).
 
 Unlike Otterize, service meshes generally aim to be the a one-stop-shop for all your needs, replacing many of the technologies you currently use. For many, this actually turns out to be friction, especially if you just want to apply authorization, and don't wish to change various technologies that are already working for you.
 

diff --git a/docs/getting-started/README.mdx b/docs/getting-started/README.mdx
@@ -25,12 +25,16 @@ The platform is composed of **Otterize OSS**, which is tailored for a single Kub
 
 Otterize enables platform engineers to easily implement, expand, and unify secured access for their Kubernetes workloads.
 ## Let's go!
-Dive right in with simple demos to:
-* [Create and manage network policies](/quick-start/access-control/k8s-network-policies).
-* [Configure secure access for Kafka using Otterize Cloud mTLS](/quick-start/access-control/k8s-kafka-mtls), or [configure secure access for Kafka using cert-manager mTLS](/quick-start/access-control/k8s-kafka-mtls).
-* [Get full visibility into pod-to-pod traffic](/quick-start/visualization/k8s-network-mapper).
-* [Create and manage Istio authorization policies](/quick-start/access-control/k8s-istio-authorization-policies).
-* [Create and manage Istio authorization policies](/quick-start/access-control/k8s-istio-authorization-policies).
+Dive right in with simple demos to manage access control:
+* [Create and manage network policies](/quickstart/access-control/k8s-network-policies).
+* [Network policies on AWS EKS with the VPC CNI](/quickstart/access-control/aws-eks-cni-mini).
+* [Create and manage Istio authorization policies](/quickstart/access-control/k8s-istio-authorization-policies).
+* [Configure secure access for Kafka using Otterize Cloud mTLS](/quickstart/access-control/k8s-kafka-mtls), or [using cert-manager mTLS](/quickstart/access-control/k8s-kafka-mtls-cert-manager).
+
+Or visualize communication in your cluster:
+* [Network mapping a Kubernetes cluster](/quickstart/visualization/k8s-network-mapper).
+* [Istio HTTP-level access mapping](/quickstart/visualization/k8s-istio-watcher).
+* [Kafka topic-level access mapping](/quickstart/visualization/k8s-network-mapper).
 
 ## Components
 

diff --git a/docs/otterize-oss/README.mdx b/docs/otterize-oss/README.mdx
@@ -24,7 +24,7 @@ This list will grow over time, as more capabilities are added, in particular sup
 
 The Otterize OSS code base and issues are managed [on GitHub](https://github.com/otterize).
 
-To get started with Otterize OSS, see the tutorials for [network policies](/quick-start/access-control/k8s-network-policies), [Kafka](/quick-start/access-control/k8s-kafka-mtls), [network mapping](/quick-start/visualization/k8s-network-mapper), and [Istio service mesh](/quick-start/access-control/k8s-istio-authorization-policies).
+To get started with Otterize OSS, see the tutorials for [network policies](/quickstart/access-control/k8s-network-policies), [Kafka](/quickstart/access-control/k8s-kafka-mtls), [network mapping](/quickstart/visualization/k8s-network-mapper), and [Istio service mesh](/quickstart/access-control/k8s-istio-authorization-policies).
 
 ## Usage metrics
 

diff --git a/docs/quick-start/_category_.json → docs/quickstart/_category_.json b/docs/quick-start/_category_.json → docs/quickstart/_category_.json
diff --git a/...uick-start/access-control/_category_.json → ...quickstart/access-control/_category_.json b/...uick-start/access-control/_category_.json → ...quickstart/access-control/_category_.json
diff --git a/...start/access-control/aws-eks-cni-mini.mdx → ...start/access-control/aws-eks-cni-mini.mdx b/...start/access-control/aws-eks-cni-mini.mdx → ...start/access-control/aws-eks-cni-mini.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 2
 title: Network policies on AWS EKS with the VPC CNI
 ---
 

diff --git a/...trol/k8s-istio-authorization-policies.mdx → ...trol/k8s-istio-authorization-policies.mdx b/...trol/k8s-istio-authorization-policies.mdx → ...trol/k8s-istio-authorization-policies.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 title: Istio AuthorizationPolicy automation
 ---
 
@@ -279,7 +279,7 @@ Try to create an intents file yourself for **client-other**, and apply it to all
 
 ## What's next
 
-- Get started with the [Otterize network mapper for Istio](/quick-start/visualization/k8s-istio-watcher) to help you bootstrap intents files with HTTP resources
+- Get started with the [Otterize network mapper for Istio](/quickstart/visualization/k8s-istio-watcher) to help you bootstrap intents files with HTTP resources
   for use in [intent-based access control (IBAC)](https://otterize.com/ibac).
 
 ## Teardown

diff --git a/...s-control/k8s-kafka-mtls-cert-manager.mdx → ...s-control/k8s-kafka-mtls-cert-manager.mdx b/...s-control/k8s-kafka-mtls-cert-manager.mdx → ...s-control/k8s-kafka-mtls-cert-manager.mdx
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
 
 This tutorial will walk you through declaring and applying intents to easily secure access to Kafka running inside a Kubernetes cluster, automating the management of [Kafka ACLs](https://docs.confluent.io/platform/current/kafka/authorization.html), and the generation and deployment of certificates for mTLS between Kafka and its clients using cert-manager as the certificate provider.
 
-If you prefer to generate certificates using Otterize Cloud, try [the tutorial for Otterize Cloud](/quick-start/access-control/k8s-kafka-mtls).
+If you prefer to generate certificates using Otterize Cloud, try [the tutorial for Otterize Cloud](/quickstart/access-control/k8s-kafka-mtls).
 
 In this tutorial, we will:
 
@@ -65,7 +65,7 @@ You may have to wait for `cert-manager` to start successfully before you are abl
 You can now install Otterize in your cluster, and connect to Otterize Cloud. Connecting to Cloud lets you:
 
 1. See what's happening visually in your browser, through the "access graph";
-2. Generate certificates using the Otterize Cloud hosted service. If you prefer to generate certificates in-cluster, you can [follow the tutorial for cert-manager](/quick-start/access-control/k8s-kafka-mtls-cert-manager).
+2. Generate certificates using the Otterize Cloud hosted service. If you prefer to generate certificates in-cluster, you can [follow the tutorial for cert-manager](/quickstart/access-control/k8s-kafka-mtls-cert-manager).
 
 <Tabs groupId="otterize-install">
 

diff --git a/...k-start/access-control/k8s-kafka-mtls.mdx → ...ckstart/access-control/k8s-kafka-mtls.mdx b/...k-start/access-control/k8s-kafka-mtls.mdx → ...ckstart/access-control/k8s-kafka-mtls.mdx
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
 
 This tutorial will walk you through declaring and applying intents to easily secure access to Kafka running inside a Kubernetes cluster, automating the management of [Kafka ACLs](https://docs.confluent.io/platform/current/kafka/authorization.html), and the generation and deployment of certificates for mTLS between Kafka and its clients using Otterize Cloud as the certificate provider.
 
-If you prefer to generate certificates using [`cert-manager`](https://cert-manager.io), try [the tutorial for cert-manager](/quick-start/access-control/k8s-kafka-mtls-cert-manager).
+If you prefer to generate certificates using [`cert-manager`](https://cert-manager.io), try [the tutorial for cert-manager](/quickstart/access-control/k8s-kafka-mtls-cert-manager).
 
 In this tutorial, we will:
 
@@ -36,7 +36,7 @@ Before you start, you'll need a Kubernetes cluster.
 You can now install Otterize in your cluster, and connect to Otterize Cloud. Connecting to Cloud lets you:
 
 1. See what's happening visually in your browser, through the "access graph";
-2. Generate certificates using the Otterize Cloud hosted service. If you prefer to generate certificates in-cluster, you can [follow the tutorial for cert-manager](/quick-start/access-control/k8s-kafka-mtls-cert-manager).
+2. Generate certificates using the Otterize Cloud hosted service. If you prefer to generate certificates in-cluster, you can [follow the tutorial for cert-manager](/quickstart/access-control/k8s-kafka-mtls-cert-manager).
 
 #### Install Otterize OSS, connected to Otterize Cloud
 

diff --git a/docs/quick-start/access-control/k8s-mtls.mdx → docs/quickstart/access-control/k8s-mtls.mdx b/docs/quick-start/access-control/k8s-mtls.mdx → docs/quickstart/access-control/k8s-mtls.mdx
@@ -328,8 +328,8 @@ For more information, see [the documentation for the credentials operator](/refe
 
 ## What's next
 
-- Learn how to manage and [automatically provision mTLS](/quick-start/access-control/k8s-mtls) credentials within a Kubernetes cluster.
-- Enforce [secure Kafka access](/quick-start/access-control/k8s-kafka-mtls) with mTLS.
+- Learn how to manage and [automatically provision mTLS](/quickstart/access-control/k8s-mtls) credentials within a Kubernetes cluster.
+- Enforce [secure Kafka access](/quickstart/access-control/k8s-kafka-mtls) with mTLS.
 - Learn more about how the [Otterize credentials operator](/reference/configuration/credentials-operator) works.
 
 ## Teardown

diff --git a/...t/access-control/k8s-network-policies.mdx → ...t/access-control/k8s-network-policies.mdx b/...t/access-control/k8s-network-policies.mdx → ...t/access-control/k8s-network-policies.mdx
@@ -299,7 +299,7 @@ Try to create an intents file yourself for **client-other**, and apply it to all
 
 ## What's next
 
-- Get started with the [Otterize network mapper](/quick-start/visualization/k8s-network-mapper) to help you bootstrap intents files
+- Get started with the [Otterize network mapper](/quickstart/visualization/k8s-network-mapper) to help you bootstrap intents files
   for use in [intent-based access control (IBAC)](https://otterize.com/ibac).
 
 ## Teardown

diff --git a/...quick-start/visualization/_category_.json → .../quickstart/visualization/_category_.json b/...quick-start/visualization/_category_.json → .../quickstart/visualization/_category_.json
diff --git a/...start/visualization/k8s-istio-watcher.mdx → ...start/visualization/k8s-istio-watcher.mdx b/...start/visualization/k8s-istio-watcher.mdx → ...start/visualization/k8s-istio-watcher.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 title: Istio HTTP-level access mapping
 ---
 
@@ -152,9 +152,9 @@ the intents files. We'll see more of that below.
 
 Where to go next?
 
-- Learn how to roll out [Istio authorization-policy-based access control](/quick-start/access-control/k8s-istio-authorization-policies) using intents.
-- If you haven't already, see the [automate network policies tutorial](/quick-start/access-control/k8s-network-policies).
-- Or go to the next tutorial to [automate secure access for Kafka](/quick-start/access-control/k8s-kafka-mtls).
+- Learn how to roll out [Istio authorization-policy-based access control](/quickstart/access-control/k8s-istio-authorization-policies) using intents.
+- If you haven't already, see the [automate network policies tutorial](/quickstart/access-control/k8s-network-policies).
+- Or go to the next tutorial to [automate secure access for Kafka](/quickstart/access-control/k8s-kafka-mtls).
 
 ### Teardown
 

diff --git a/...start/visualization/k8s-kafka-mapping.mdx → ...start/visualization/k8s-kafka-mapping.mdx b/...start/visualization/k8s-kafka-mapping.mdx → ...start/visualization/k8s-kafka-mapping.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 title: Kafka topic-level access mapping
 ---
 
@@ -153,7 +153,7 @@ You can consume this information in various ways:
 
 ## What's next
 
-- Try our [secure access for Kafka](/quick-start/access-control/k8s-kafka-mtls) tutorial
+- Try our [secure access for Kafka](/quickstart/access-control/k8s-kafka-mtls) tutorial
 
 ## Teardown
 

diff --git a/...tart/visualization/k8s-network-mapper.mdx → ...tart/visualization/k8s-network-mapper.mdx b/...tart/visualization/k8s-network-mapper.mdx → ...tart/visualization/k8s-network-mapper.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 1
 title: Network mapping a Kubernetes cluster
 ---
 
@@ -112,8 +112,8 @@ the intents files. We'll see more of that below.
 
 Where to go next?
 
-- If you haven't already, see the [automate network policies tutorial](/quick-start/access-control/k8s-network-policies).
-- Or go to the next tutorial to [automate secure access for Kafka](/quick-start/access-control/k8s-kafka-mtls).
+- If you haven't already, see the [automate network policies tutorial](/quickstart/access-control/k8s-network-policies).
+- Or go to the next tutorial to [automate secure access for Kafka](/quickstart/access-control/k8s-kafka-mtls).
 
 ### Teardown
 

diff --git a/docs/reference/cli/README.mdx b/docs/reference/cli/README.mdx
@@ -4,7 +4,7 @@ title: CLI
 ---
 
 The Otterize command line interface (CLI) offers the following capabilities:
-- [Interact with](#network-mapper) the [Otterize network mapper](/quick-start/visualization/k8s-network-mapper) running in a Kubernetes cluster.
+- [Interact with](#network-mapper) the [Otterize network mapper](/quickstart/visualization/k8s-network-mapper) running in a Kubernetes cluster.
 - [Transform](#otterize-intents-convert--f-path) [intents files](/reference/intents-and-intents-files/#intents-file-formats) from plain YAML format to Kubernetes custom resource YAML format.
 - Interact with the Otterize Cloud, through its REST API.
 

diff --git a/docs/reference/configuration/intents-operator/README.mdx b/docs/reference/configuration/intents-operator/README.mdx
@@ -19,7 +19,7 @@ to connect to Kafka using mTLS &mdash; the Otterize intents operator works with
 To deploy the operator, [use the Helm chart](/reference/configuration/intents-operator/helm-chart).
 
 ## Controlling access using the intents operator
-To learn how to use the intents operator to control access, consult the guides for [managing network policies using intents](/quick-start/access-control/k8s-network-policies), [Kafka ACLs using intents](/quick-start/access-control/k8s-kafka-mtls) and [Istio AuthorizationPolicy using intents](/quick-start/access-control/k8s-istio-authorization-policies).
+To learn how to use the intents operator to control access, consult the guides for [managing network policies using intents](/quickstart/access-control/k8s-network-policies), [Kafka ACLs using intents](/quickstart/access-control/k8s-kafka-mtls) and [Istio AuthorizationPolicy using intents](/quickstart/access-control/k8s-istio-authorization-policies).
 
 ## Pod annotations
 

diff --git a/docs/reference/configuration/network-mapper/README.mdx b/docs/reference/configuration/network-mapper/README.mdx
@@ -8,7 +8,7 @@ The Otterize network mapper creates a map of in-cluster traffic by (1) capturing
 You can then use the Otterize CLI to list the traffic by client, reset the traffic the mapper remembers, or export it as JSON or YAML, which serves as ClientIntents Kubernetes resources). ClientIntents can be consumed by the [Otterize intents operator](/reference/configuration/intents-operator) to apply network policies
 or Kafka ACLs to your cluster, implementing [intent-based access control](/intent-based-access-control).
 
-To get started, follow the [quick hands-on tutorial](/quick-start/visualization/k8s-network-mapper)
+To get started, follow the [quick hands-on tutorial](/quickstart/visualization/k8s-network-mapper)
 
 ```shell
 cartservice in namespace otterize-ecom-demo calls:

diff --git a/docs/reference/configuration/network-mapper/helm-chart.mdx b/docs/reference/configuration/network-mapper/helm-chart.mdx
@@ -7,7 +7,7 @@ To deploy the network mapper, do the following:
 {@include: ../../../_common/install-otterize-network-mapper.md}
 
 :::tip
-Checkout the network mapper [tutorial](/quick-start/visualization/k8s-network-mapper) to see it in action.
+Checkout the network mapper [tutorial](/quickstart/visualization/k8s-network-mapper) to see it in action.
 :::
 
 # Parameters

diff --git a/docs/reference/mtls/README.mdx b/docs/reference/mtls/README.mdx
@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
 
 Otterize can automatically provision mTLS credentials using Kubernetes pod identities
 and integrating with [SPIFFE/SPIRE](https://spiffe.io/docs/latest/spire-about/spire-concepts/).
-You can see a simple example in the tutorial: [deploy mTLS between pods](/quick-start/access-control/k8s-mtls).
+You can see a simple example in the tutorial: [deploy mTLS between pods](/quickstart/access-control/k8s-mtls).
 Here we document how to generate mTLS credentials, how to consume them in a variety of languages,
 and how to verify them if needed.
 
@@ -205,5 +205,5 @@ The certificate belongs to a chain of trust rooted at the SPIRE server.
 
 ## What's next
 
-- Configure secure access between pods and Kafka running within the same Kubernetes cluster with this [guide](/quick-start/access-control/k8s-kafka-mtls).
+- Configure secure access between pods and Kafka running within the same Kubernetes cluster with this [guide](/quickstart/access-control/k8s-kafka-mtls).
 - Read more about the [Otterize credentials operator](/reference/configuration/credentials-operator/)
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -38,6 +38,30 @@ const config = {
           from: '/getting-started/oss-installation',
           to: '/installation',
         },
+        {
+          from: '/quick-tutorials/k8s-network-policies',
+          to: '/quickstart/access-control/k8s-network-policies',
+        },
+        {
+          from: '/quick-tutorials/k8s-istio-authorization-policies',
+          to: '/quickstart/access-control/k8s-istio-authorization-policies',
+        },
+        {
+          from: '/quick-tutorials/k8s-kafka-mtls',
+          to: '/quickstart/access-control/k8s-kafka-mtls',
+        },
+        {
+          from: '/quick-tutorials/aws-eks-cni-mini',
+          to: '/quickstart/access-control/aws-eks-cni-mini',
+        },
+        {
+          from: '/quick-tutorials/k8s-kafka-mtls-cert-manager',
+          to: '/quickstart/access-control/k8s-kafka-mtls-cert-manager',
+        },
+        {
+          from: '/quick-tutorials/k8s-mtls',
+          to: '/quickstart/access-control/k8s-mtls',
+        },
         // Redirect from multiple old paths to the new path
         // {
         //   to: '/docs/newDoc2',