sidebars.js

/*
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  // sidebar: [{ type: 'autogenerated', dirName: '.' }],
  // But you can create a sidebar manually
  docs: [
    {
      type: "category",
      label: "👋\xa0\xa0Welcome",
      collapsed: true,
      items: [
        "welcome/getting-started/index",
        "welcome/how-datree-works/index",
      ],
    },
    {
      type: "category",
      label: "🛠️\xa0\xa0Configuration",
      collapsed: true,
      items: [
        "configuration/overview/index",
        "configuration/behavior/index",
        "configuration/cluster-scan/index",
        "configuration/output/index",
      ],
    },
    {
      type: "category",
      label: "📊\xa0\xa0Dashboard",
      collapsed: true,
      items: [
        "dashboard/clusters/index",
        "dashboard/repairing/index",
        "dashboard/policies/index",
        "dashboard/activity-log/index",
        "dashboard/account-token/index",
        "dashboard/policy-as-code/index",
        "dashboard/user-management/index",
      ],
    },
    {
      type: "category",
      label: "🚔\xa0\xa0Built-in rules",
      collapsible: false,
      collapsed: false,
      className: "built-in-rules-navbar-items",
      link: {
        type: "doc",
        id: "built-in-rules/index",
      },
      items: [
        "built-in-rules/prevent-deprecated-k8s-api-116/index",
        "built-in-rules/prevent-deprecated-k8s-api-117/index",
        "built-in-rules/prevent-deprecated-k8s-api-116/index",
        "built-in-rules/prevent-deprecated-k8s-api-117/index",
        "built-in-rules/prevent-deprecated-k8s-api-119/index",
        "built-in-rules/prevent-deprecated-k8s-api-121/index",
        "built-in-rules/prevent-deprecated-k8s-api-122/index",
        "built-in-rules/prevent-deprecated-k8s-api-123/index",
        "built-in-rules/prevent-deprecated-k8s-api-124/index",
        "built-in-rules/ensure-read-only-filesystem/index",
        "built-in-rules/prevent-accessing-host-files-by-using-high-gids/index",
        "built-in-rules/prevent-accessing-underlying-host/index",
        "built-in-rules/prevent-allowing-command-execution/index",
        "built-in-rules/prevent-escalating-privileges/index",
        "built-in-rules/prevent-insecure-capabilities/index",
        "built-in-rules/prevent-insecurely-exposing-workload/index",
        "built-in-rules/prevent-running-with-root-privileges/index",
        "built-in-rules/prevent-service-account-token-auto-mount/index",
        "built-in-rules/ensure-env-label/index",
        "built-in-rules/ensure-labels-value-valid/index",
        "built-in-rules/ensure-minimum-two-replicas/index",
        "built-in-rules/ensure-owner-label/index",
        "built-in-rules/ensure-valid-restart-policy/index",
        "built-in-rules/prevent-default-namespace/index",
        "built-in-rules/ensure-application-and-appproject-are-part-of-the-argocd-namespace/index",
        "built-in-rules/ensure-configmap-is-recognized-by-argocd/index",
        "built-in-rules/ensure-rollout-allows-broadcasting-ip-table-changes/index",
        "built-in-rules/ensure-rollout-has-revision-history-set/index",
        "built-in-rules/ensure-rollout-pause-step-has-a-configured-duration/index",
        "built-in-rules/ensure-rollout-that-is-marked-as-degraded-scales-down-replicaset/index",
        "built-in-rules/ensure-workflow-dag-fail-fast-on-node-failure/index",
        "built-in-rules/ensure-workflow-retry-policy-catches-relevant-errors-only/index",
        "built-in-rules/prevent-workflow-from-having-an-empty-retry-strategy/index",
        "built-in-rules/prevent-workflow-pods-from-using-the-default-service-account/index",
        "built-in-rules/ensure-cpu-limit/index",
        "built-in-rules/ensure-cpu-request/index",
        "built-in-rules/ensure-digest-tag/index",
        "built-in-rules/ensure-image-pinned-version/index",
        "built-in-rules/ensure-liveness-probe/index",
        "built-in-rules/ensure-memory-limit/index",
        "built-in-rules/ensure-memory-request/index",
        "built-in-rules/ensure-readiness-probe/index",
        "built-in-rules/prevent-mounting-docker-socket/index",
        "built-in-rules/prevent-privileged-containers/index",
        "built-in-rules/prevent-uid-conflicts/index",
        "built-in-rules/prevent-using-host-ipc/index",
        "built-in-rules/prevent-using-host-network/index",
        "built-in-rules/prevent-using-host-pid/index",
        "built-in-rules/ensure-initial-probe-delay/index",
        "built-in-rules/ensure-probe-frequency/index",
        "built-in-rules/ensure-probe-timeout/index",
        "built-in-rules/ensure-probe-min-success-threshold/index",
        "built-in-rules/ensure-probe-failure-threshold/index",
        "built-in-rules/ensure-prestop/index",
        "built-in-rules/prevent-system-call-privileges/index",
        "built-in-rules/ensure-cronjob-deadline/index",
        "built-in-rules/ensure-cronjob-scheduler-valid/index",
        "built-in-rules/prevent-cronjob-concurrency/index",
        "built-in-rules/index",
        "built-in-rules/prevent-ingress-forwarding-traffic-to-single-container/index",
        "built-in-rules/prevent-node-port/index",
        "built-in-rules/ensure-resource-name/index",
        "built-in-rules/ensure-hpa-maximum-replicas/index",
        "built-in-rules/ensure-hpa-minimum-replicas/index",
        "built-in-rules/prevent-naked-pods/index",
        "built-in-rules/prevent-configmap-security-vulnerability-cve-2021-25742/index",
        "built-in-rules/prevent-container-security-vulnerability-cve-2021-25741/index",
        "built-in-rules/prevent-endpointslice-validation-from-enabling-host-network-hijack-cve-2021-25737/index",
        "built-in-rules/prevent-ingress-security-vulnerability-cve-2021-25742/index",
        "built-in-rules/prevent-exposed-secrets-bitbucket/index",
        "built-in-rules/prevent-exposed-secrets-datadog/index",
        "built-in-rules/prevent-exposed-secrets-gcp/index",
        "built-in-rules/prevent-exposed-secrets-aws/index",
        "built-in-rules/prevent-exposed-secrets-github/index",
        "built-in-rules/prevent-exposed-secrets-gitlab/index",
        "built-in-rules/prevent-exposed-secrets-terraform/index",
        "built-in-rules/prevent-exposed-secrets-heroku/index",
        "built-in-rules/prevent-exposed-secrets-jwt/index",
        "built-in-rules/prevent-exposed-secrets-launchdarkly/index",
        "built-in-rules/prevent-exposed-secrets-newrelic/index",
        "built-in-rules/prevent-exposed-secrets-npm/index",
        "built-in-rules/prevent-exposed-secrets-okta/index",
        "built-in-rules/prevent-exposed-secrets-stripe/index",
        "built-in-rules/prevent-exposed-secrets-sumologic/index",
        "built-in-rules/prevent-exposed-secrets-twilio/index",
        "built-in-rules/prevent-exposed-secrets-vault/index",
        "built-in-rules/prevent-exposed-secrets-privatekey/index",
        "built-in-rules/ensure-no-cpu-limit/index",
        "built-in-rules/ensure-memory-request-limit-equal/index",
        "built-in-rules/ensure-containers-limited-capabilities/index",
        "built-in-rules/ensure-replicas-different-nodes/index",
        "built-in-rules/prevent-pods-becoming-unschedulable/index",
        "built-in-rules/prevent-windows-containers-unnecessary-privileges/index",
        "built-in-rules/prevent-selinux-containers-unnecessary-privileges/index",
        "built-in-rules/prevent-selinux-containers-user/index",
        "built-in-rules/prevent-selinux-containers-role/index",
        "built-in-rules/ensure-hostpath-mounts-readonly/index",
        "built-in-rules/prevent-cluster-admin-role/index",
        "built-in-rules/prevent-access-to-secrets/index",
        "built-in-rules/prevent-wildcards-role-clusterrole/index",
        "built-in-rules/prevent-secrets-as-env-variables/index",
        "built-in-rules/ensure-seccomp-profile-default/index",
        "built-in-rules/ensure-containers-pods-security-context/index",
        "built-in-rules/prevent-access-create-pods/index",
        "built-in-rules/ensure-default-service-account-not-used/index",
        "built-in-rules/prevent-containers-net-raw-capability/index",
        "built-in-rules/prevent-system-masters-group/index",
        "built-in-rules/prevent-role-privilege-escalation/index",
        "built-in-rules/prevent-removed-k8s-api-122/index",
        "built-in-rules/prevent-removed-k8s-api-123/index",
        "built-in-rules/prevent-removed-k8s-api-124/index",
        "built-in-rules/prevent-removed-k8s-api-125/index",
        "built-in-rules/prevent-removed-k8s-api-126/index",
        "built-in-rules/prevent-removed-k8s-api-127/index",
      ],
    },
    {
      type: "category",
      label: "🤖\xa0\xa0Custom rules",
      collapsed: true,
      items: [
        "custom-rules/custom-rules-overview/index",
        "custom-rules/rego-support/index",
        "custom-rules/cel-support/index",
        "custom-rules/examples/index",
        "custom-rules/multiple-property-paths/index",
        "custom-rules/resource-quotas/index",
      ],
    },
    {
      type: "category",
      label: "🔌\xa0\xa0Integrations",
      link: {
        type: "doc",
        id: "official-integrations/index",
      },
      collapsed: true,
      items: [
        "official-integrations/eks-integration/index",
        {
          type: "category",
          label: "Github",
          link: {
            type: "doc",
            id: "official-integrations/github/index",
          },
          items: [
            {
              type: "link",
              label: "Github action",
              href: "https://github.com/datreeio/action-datree",
            },
            {
              type: "link",
              label: "Github code scanning",
              href: "https://github.com/datreeio/action-datree#github-code-scanning-sarif",
            },
          ],
        },
        {
          type: "link",
          label: "Kubectl plugin",
          href: "https://github.com/datreeio/kubectl-datree",
        },
        {
          type: "link",
          label: "Drone plugin",
          href: "https://github.com/datreeio/drone-datree",
        },
        {
          type: "link",
          label: "CircleCI orb",
          href: "https://github.com/datreeio/datree-circleci-orb",
        },
        {
          type: "link",
          label: "Tekton task",
          href: "https://hub.tekton.dev/tekton/task/datree",
        },
        {
          type: "link",
          label: "Codefresh plugin",
          href: "https://github.com/datreeio/codefresh-datree",
        },
        {
          type: "link",
          label: "Helm plugin",
          href: "https://github.com/datreeio/helm-datree",
        },
        "official-integrations/kustomize-support/index",
        "official-integrations/git-hooks/index",
        "official-integrations/pre-commit-hook/index",
      ],
    },
    {
      type: "category",
      label: "🖥\xa0\xa0CLI",
      collapsed: true,
      items: [
        "cli/getting-started/index",
        "cli/schema-validation/index",
        "cli/cli-output/index",
        "cli/cli-arguments/index",
        "cli/offline-mode/index",
      ],
    },
    {
      type: "category",
      label: "⏩\xa0\xa0CI/CD examples",
      link: {
        type: "doc",
        id: "cicd-examples/index",
      },
      collapsed: true,
      items: [
        "cicd-examples/github-workflow/index",
        "cicd-examples/circle-ci/index",
        "cicd-examples/travis-ci/index",
        "cicd-examples/gitlab-cicd/index",
        "cicd-examples/jenkins-pipeline/index",
        "cicd-examples/drone-pipeline/index",
        "cicd-examples/azure-pipelines/index",
        "cicd-examples/codefresh/index",
      ],
    },
    {
      type: "doc",
      label: "🔐\xa0\xa0Data privacy",
      id: "data-privacy/index",
    },
    {
      type: "doc",
      label: "🗃️\xa0\xa0Troubleshooting",
      id: "troubleshooting/index",
    },
    {
      type: "category",
      label: "📕\xa0\xa0Guides & articles",
      collapsed: true,
      items: [
        "guides/integration-guide/index",
        "guides/argo-integration/index",
        "guides/downgrading-to-community/index",
      ],
    },
    {
      type: "link",
      label: "📚\xa0\xa0Resources",
      href: "https://github.com/datreeio/awesome-datree/blob/main/README.md",
    },
  ],
};

module.exports = sidebars;