sidebars-calico.js

// This is the navigation file for Calico Open Source

module.exports = {
  calicoSidebar: [
    {
      type: 'category',
      label: 'About',
      link: {
        type: 'doc',
        id: 'about/index',
      },
      items: [
        'about/about-k8s-networking',
        'about/about-network-policy',
        'about/about-kubernetes-services',
        'about/about-kubernetes-ingress',
        'about/about-kubernetes-egress',
        'about/about-ebpf',
      ],
    },
    {
      type: 'category',
      label: 'Install Calico',
      link: {
        type: 'doc',
        id: 'getting-started/index',
      },
      items: [
        {
          type: 'category',
          label: 'Kubernetes',
          link: { type: 'doc', id: 'getting-started/kubernetes/index' },
          items: [
            'getting-started/kubernetes/requirements',
            'getting-started/kubernetes/community-tested',
            'getting-started/kubernetes/quickstart',
            {
              type: 'category',
              label: 'Managed public cloud',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/managed-public-cloud/index',
              },
              items: [
                'getting-started/kubernetes/managed-public-cloud/eks',
                'getting-started/kubernetes/managed-public-cloud/gke',
                'getting-started/kubernetes/managed-public-cloud/iks',
                'getting-started/kubernetes/managed-public-cloud/aks',
              ],
            },
            {
              type: 'category',
              label: 'Self-managed public cloud',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/self-managed-public-cloud/index',
              },
              items: [
                'getting-started/kubernetes/self-managed-public-cloud/aws',
                'getting-started/kubernetes/self-managed-public-cloud/gce',
                'getting-started/kubernetes/self-managed-public-cloud/azure',
                'getting-started/kubernetes/self-managed-public-cloud/do',
              ],
            },
            {
              type: 'category',
              label: 'Self-managed on-premises',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/self-managed-onprem/index',
              },
              items: [
                'getting-started/kubernetes/self-managed-onprem/onpremises',
                'getting-started/kubernetes/self-managed-onprem/config-options',

              ],
            },
            {
              type: 'category',
              label: 'OpenShift',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/openshift/index',
              },
              items: [
                'getting-started/kubernetes/openshift/requirements',
                'getting-started/kubernetes/openshift/installation',
              ],
            },
            'getting-started/kubernetes/rancher',
            {
              type: 'category',
              label: 'Flannel',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/flannel/index',
              },
              items: [
                'getting-started/kubernetes/flannel/install-for-flannel',
                'getting-started/kubernetes/flannel/migration-from-flannel',
              ],
            },
            {
              type: 'category',
              label: 'Calico for Windows',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/windows-calico/index',
              },
              items: [
                'getting-started/kubernetes/windows-calico/limitations',
                'getting-started/kubernetes/windows-calico/quickstart',
                'getting-started/kubernetes/windows-calico/demo',
                {
                  type: 'category',
                  label: 'Kubernetes',
                  link: {
                    type: 'doc',
                    id: 'getting-started/kubernetes/windows-calico/kubernetes/index',
                  },
                  items: [
                    'getting-started/kubernetes/windows-calico/kubernetes/requirements',
                    'getting-started/kubernetes/windows-calico/kubernetes/standard',
                    'getting-started/kubernetes/windows-calico/kubernetes/rancher',
                  ],
                },
                'getting-started/kubernetes/windows-calico/openshift-installation',
                'getting-started/kubernetes/windows-calico/kubeconfig',
                'getting-started/kubernetes/windows-calico/maintain',
                'getting-started/kubernetes/windows-calico/troubleshoot',
              ],
            },
            {
              type: 'category',
              label: 'K3s',
              link: { type: 'doc', id: 'getting-started/kubernetes/k3s/index' },
              items: [
                'getting-started/kubernetes/k3s/quickstart',
                'getting-started/kubernetes/k3s/multi-node-install',
              ],
            },
            'getting-started/kubernetes/helm',
            'getting-started/kubernetes/microk8s',
            'getting-started/kubernetes/minikube',
            'getting-started/kubernetes/kind',
            {
              type: 'category',
              label: 'Calico the hard way',
              link: {
                type: 'doc',
                id: 'getting-started/kubernetes/hardway/index',
              },
              items: [
                'getting-started/kubernetes/hardway/overview',
                'getting-started/kubernetes/hardway/standing-up-kubernetes',
                'getting-started/kubernetes/hardway/the-calico-datastore',
                'getting-started/kubernetes/hardway/configure-ip-pools',
                'getting-started/kubernetes/hardway/install-cni-plugin',
                'getting-started/kubernetes/hardway/install-typha',
                'getting-started/kubernetes/hardway/install-node',
                'getting-started/kubernetes/hardway/configure-bgp-peering',
                'getting-started/kubernetes/hardway/test-networking',
                'getting-started/kubernetes/hardway/test-network-policy',
                'getting-started/kubernetes/hardway/end-user-rbac',
                'getting-started/kubernetes/hardway/istio-integration',
              ],
            },
            {
              type: 'category',
              label: 'VPP dataplane',
              link: { type: 'doc', id: 'getting-started/kubernetes/vpp/index' },
              items: [
                'getting-started/kubernetes/vpp/getting-started',
                'getting-started/kubernetes/vpp/ipsec',
                'getting-started/kubernetes/vpp/specifics',
              ],
            },
          ],
        },
        {
          type: 'category',
          label: 'OpenStack',
          link: { type: 'doc', id: 'getting-started/openstack/index' },
          items: [
            'getting-started/openstack/overview',
            'getting-started/openstack/requirements',
            {
              type: 'category',
              label: 'Installation',
              link: {
                type: 'doc',
                id: 'getting-started/openstack/installation/index',
              },
              items: [
                'getting-started/openstack/installation/overview',
                'getting-started/openstack/installation/ubuntu',
                'getting-started/openstack/installation/redhat',
                'getting-started/openstack/installation/devstack',
                'getting-started/openstack/installation/verification',
              ],
            },
          ],
        },
        {
          type: 'category',
          label: 'Non-cluster hosts',
          link: { type: 'doc', id: 'getting-started/bare-metal/index' },
          items: [
            'getting-started/bare-metal/about',
            'getting-started/bare-metal/requirements',
            {
              type: 'category',
              label: 'Installation',
              link: {
                type: 'doc',
                id: 'getting-started/bare-metal/installation/index',
              },
              items: [
                'getting-started/bare-metal/installation/container',
                'getting-started/bare-metal/installation/binary-mgr',
                'getting-started/bare-metal/installation/binary',
              ],
            },
          ],
        },
      ],
    },
    {
      type: 'category',
      label: 'Networking',
      link: { type: 'doc', id: 'networking/index' },
      items: [
        'networking/determine-best-networking',
        {
          type: 'category',
          label: 'Configure networking',
          link: { type: 'doc', id: 'networking/configuring/index' },
          items: [
            'networking/configuring/bgp',
            'networking/configuring/vxlan-ipip',
            'networking/configuring/advertise-service-ips',
            'networking/configuring/mtu',
            'networking/configuring/workloads-outside-cluster',
            'networking/configuring/use-ipvs',
            'networking/configuring/sidecar-acceleration',
            'networking/configuring/pod-mac-address',
          ],
        },
        {
          type: 'category',
          label: 'Customize IP address management',
          link: { type: 'doc', id: 'networking/ipam/index' },
          items: [
            'networking/ipam/get-started-ip-addresses',
            'networking/ipam/ip-autodetection',
            'networking/ipam/ipv6',
            'networking/ipam/ipv6-control-plane',
            'networking/ipam/add-floating-ip',
            'networking/ipam/use-specific-ip',
            'networking/ipam/assign-ip-addresses-topology',
            'networking/ipam/migrate-pools',
            'networking/ipam/change-block-size',
            'networking/ipam/legacy-firewalls',
          ],
        },
        {
          type: 'category',
          label: 'Calico networking for OpenStack',
          link: { type: 'doc', id: 'networking/openstack/index' },
          items: [
            'networking/openstack/dev-machine-setup',
            'networking/openstack/ipv6',
            'networking/openstack/connectivity',
            'networking/openstack/labels',
            'networking/openstack/configuration',
            'networking/openstack/semantics',
            'networking/openstack/floating-ips',
            'networking/openstack/service-ips',
            'networking/openstack/host-routes',
            'networking/openstack/multiple-regions',
            'networking/openstack/kuryr',
            'networking/openstack/neutron-api',
          ],
        },
      ],
    },
    {
      type: 'category',
      label: 'Security',
      link: { type: 'doc', id: 'network-policy/index' },
      items: [
        'network-policy/adopt-zero-trust',
        'network-policy/non-privileged',
        {
          type: 'category',
          label: 'Get started with policy',
          link: { type: 'doc', id: 'network-policy/get-started/index' },
          items: [
            {
              type: 'category',
              label: 'Calico policy',
              link: {
                type: 'doc',
                id: 'network-policy/get-started/calico-policy/index',
              },
              items: [
                'network-policy/get-started/calico-policy/calico-network-policy',
                'network-policy/get-started/calico-policy/network-policy-openstack',
                'network-policy/get-started/calico-policy/calico-policy-tutorial',
              ],
            },
            {
              type: 'category',
              label: 'Kubernetes policy',
              link: {
                type: 'doc',
                id: 'network-policy/get-started/kubernetes-policy/index',
              },
              items: [
                'network-policy/get-started/kubernetes-policy/kubernetes-network-policy',
                'network-policy/get-started/kubernetes-policy/kubernetes-demo',
                'network-policy/get-started/kubernetes-policy/kubernetes-policy-basic',
                'network-policy/get-started/kubernetes-policy/kubernetes-policy-advanced',
              ],
            },
            'network-policy/get-started/kubernetes-default-deny',
          ],
        },
        {
          type: 'category',
          label: 'Policy rules',
          link: { type: 'doc', id: 'network-policy/policy-rules/index' },
          items: [
            'network-policy/policy-rules/policy-rules-overview',
            'network-policy/policy-rules/namespace-policy',
            'network-policy/policy-rules/service-policy',
            'network-policy/policy-rules/service-accounts',
            'network-policy/policy-rules/external-ips-policy',
            'network-policy/policy-rules/icmp-ping',

          ],
        },
        {
          type: 'category',
          label: 'Policy for hosts',
          link: { type: 'doc', id: 'network-policy/hosts/index' },
          items: [
            'network-policy/hosts/protect-hosts',
            'network-policy/hosts/kubernetes-nodes',
            'network-policy/hosts/protect-hosts-tutorial',
            'network-policy/hosts/host-forwarded-traffic',
          ],
        },
        {
          type: 'category',
          label: 'Policy for services',
          link: { type: 'doc', id: 'network-policy/services/index' },
          items: [
            'network-policy/services/kubernetes-node-ports',
            'network-policy/services/services-cluster-ips',
          ],
        },
        {
          type: 'category',
          label: 'Policy for Istio',
          link: { type: 'doc', id: 'network-policy/istio/index' },
          items: [
            'network-policy/istio/app-layer-policy',
            'network-policy/istio/http-methods',
            'network-policy/istio/enforce-policy-istio',
          ],
        },
        {
          type: 'category',
          label: 'Policy for extreme traffic',
          link: { type: 'doc', id: 'network-policy/extreme-traffic/index' },
          items: [
            'network-policy/extreme-traffic/high-connection-workloads',
            'network-policy/extreme-traffic/defend-dos-attack',
          ],
        },
        'network-policy/encrypt-cluster-pod-traffic',
        {
          type: 'category',
          label: 'Secure Calico component communications',
          link: { type: 'doc', id: 'network-policy/comms/index' },
          items: [
            'network-policy/comms/crypto-auth',
            'network-policy/comms/reduce-nodes',
            'network-policy/comms/secure-metrics',
            'network-policy/comms/secure-bgp',
          ],
        },
      ],
    },

    {
      type: 'category',
      label: 'Operations',
      link: { type: 'doc', id: 'operations/index' },
      items: [
        {
          type: 'category',
          label: 'Upgrade',
          link: { type: 'doc', id: 'operations/upgrading/index' },
          items: [
            'operations/upgrading/kubernetes-upgrade',
            'operations/upgrading/openshift-upgrade',
            'operations/upgrading/openstack-upgrade',
          ],
        },
        {
          type: 'category',
          label: 'calicoctl',
          link: { type: 'doc', id: 'operations/calicoctl/index' },
          items: [
            'operations/calicoctl/install',
            {
              type: 'category',
              label: 'Configure calicoctl',
              link: {
                type: 'doc',
                id: 'operations/calicoctl/configure/index',
              },
              items: [
                'operations/calicoctl/configure/overview',
                'operations/calicoctl/configure/etcd',
                'operations/calicoctl/configure/kdd',
              ],
            },
          ],
        },
        {
          type: 'category',
          label: 'Deploy image options',
          link: { type: 'doc', id: 'operations/image-options/index' },
          items: [
            'operations/image-options/imageset',
            'operations/image-options/alternate-registry',
          ],
        },
        'operations/datastore-migration',
        'operations/operator-migration',
        'operations/install-apiserver',
        {
          type: 'category',
          label: 'eBPF',
          link: { type: 'doc', id: 'operations/ebpf/index' },
          items: [
            'operations/ebpf/use-cases-ebpf',
            'operations/ebpf/enabling-ebpf',
            'operations/ebpf/install',
            'operations/ebpf/troubleshoot-ebpf',
          ],
        },
        {
          type: 'category',
          label: 'Monitor',
          link: { type: 'doc', id: 'operations/monitor/index' },
          items: [
            'operations/monitor/monitor-component-metrics',
            'operations/monitor/monitor-component-visual',
          ],
        },
        'operations/decommissioning-a-node',
        'operations/fips',
        {
          type: 'category',
          label: 'Troubleshoot',
          link: { type: 'doc', id: 'operations/troubleshoot/index' },
          items: [
            'operations/troubleshoot/troubleshooting',
            'operations/troubleshoot/commands',
            'operations/troubleshoot/component-logs',
            //NOTE: Source doubled up on 'operations/ebpf/troubleshoot-ebpf'. Removing from here.
            'operations/troubleshoot/vpp',
          ],
        },
        'operations/certificate-management',
      ],
    },
    {
      type: 'category',
      label: 'Reference',
      link: { type: 'doc', id: 'reference/index' },
      items: [
        'reference/api',
        {
          type: 'doc',
          id: 'reference/installation/api',
          label: 'Installation API',
        },
        // TODO: 'Installation' category needs to be collapsed into single Operator API page
        {
          type: 'category',
          label: 'calicoctl',
          link: { type: 'doc', id: 'reference/calicoctl/index' },
          items: [
            'reference/calicoctl/overview',
            'reference/calicoctl/create',
            'reference/calicoctl/replace',
            'reference/calicoctl/apply',
            'reference/calicoctl/delete',
            'reference/calicoctl/get',
            'reference/calicoctl/patch',
            'reference/calicoctl/label',
            'reference/calicoctl/convert',
            {
              type: 'category',
              label: 'ipam',
              link: { type: 'doc', id: 'reference/calicoctl/ipam/index' },
              items: [
                'reference/calicoctl/ipam/overview',
                'reference/calicoctl/ipam/check',
                'reference/calicoctl/ipam/release',
                'reference/calicoctl/ipam/show',
                'reference/calicoctl/ipam/configure',
                'reference/calicoctl/ipam/split',
              ],
            },
            {
              type: 'category',
              label: 'node',
              link: { type: 'doc', id: 'reference/calicoctl/node/index' },
              items: [
                'reference/calicoctl/node/overview',
                'reference/calicoctl/node/run',
                'reference/calicoctl/node/status',
                'reference/calicoctl/node/diags',
                'reference/calicoctl/node/checksystem',
              ],
            },
            {
              type: 'category',
              label: 'datastore',
              link: { type: 'doc', id: 'reference/calicoctl/datastore/index' },
              items: [
                'reference/calicoctl/datastore/overview',
                {
                  type: 'category',
                  label: 'migrate',
                  link: {
                    type: 'doc',
                    id: 'reference/calicoctl/datastore/migrate/index',
                  },
                  items: [
                    'reference/calicoctl/datastore/migrate/overview',
                    'reference/calicoctl/datastore/migrate/export',
                    'reference/calicoctl/datastore/migrate/import',
                    'reference/calicoctl/datastore/migrate/lock',
                    'reference/calicoctl/datastore/migrate/unlock',
                  ],
                },
              ],
            },
            'reference/calicoctl/version',
          ],
        },
        {
          type: 'category',
          label: 'Resource definitions',
          link: { type: 'doc', id: 'reference/resources/index' },
          items: [
            'reference/resources/overview',
            'reference/resources/bgpconfig',
            'reference/resources/bgppeer',
            'reference/resources/bgpfilter',
            'reference/resources/blockaffinity',
            'reference/resources/caliconodestatus',
            'reference/resources/felixconfig',
            'reference/resources/globalnetworkpolicy',
            'reference/resources/globalnetworkset',
            'reference/resources/hostendpoint',
            'reference/resources/ippool',
            'reference/resources/ipreservation',
            'reference/resources/ipamconfig',
            'reference/resources/kubecontrollersconfig',
            'reference/resources/networkpolicy',
            'reference/resources/networkset',
            'reference/resources/node',
            'reference/resources/profile',
            'reference/resources/workloadendpoint',
          ],
        },
        {
          type: 'category',
          label: 'Configuring etcd RBAC',
          link: { type: 'doc', id: 'reference/etcd-rbac/index' },
          items: [
            'reference/etcd-rbac/overview',
            'reference/etcd-rbac/certificate-generation',
            'reference/etcd-rbac/users-and-roles',
            'reference/etcd-rbac/kubernetes',
            'reference/etcd-rbac/kubernetes-advanced',
            'reference/etcd-rbac/calico-etcdv3-paths',
          ],
        },
        'reference/configure-calico-node',
        {
          type: 'category',
          label: 'Felix',
          link: { type: 'doc', id: 'reference/felix/index' },
          items: [
            'reference/felix/configuration',
            'reference/felix/prometheus',
          ],
        },
        {
          type: 'category',
          label: 'Typha',
          link: { type: 'doc', id: 'reference/typha/index' },
          items: [
            'reference/typha/overview',
            'reference/typha/configuration',
            'reference/typha/prometheus',
          ],
        },
        'reference/configure-cni-plugins',
        {
          type: 'category',
          label: 'Calico Kubernetes controllers',
          link: { type: 'doc', id: 'reference/kube-controllers/index' },
          items: [
            'reference/kube-controllers/configuration',
            'reference/kube-controllers/prometheus',
          ],
        },
        {
          type: 'category',
          label: 'Configuration on public clouds',
          link: { type: 'doc', id: 'reference/public-cloud/index' },
          items: [
            'reference/public-cloud/aws',
            'reference/public-cloud/azure',
            'reference/public-cloud/gce',
            'reference/public-cloud/ibm',
          ],
        },
        {
          type: 'category',
          label: 'Host endpoints',
          link: { type: 'doc', id: 'reference/host-endpoints/index' },
          items: [
            'reference/host-endpoints/overview',
            'reference/host-endpoints/connectivity',
            'reference/host-endpoints/objects',
            'reference/host-endpoints/selector',
            'reference/host-endpoints/failsafe',
            'reference/host-endpoints/pre-dnat',
            'reference/host-endpoints/forwarded',
            'reference/host-endpoints/summary',
            'reference/host-endpoints/conntrack',
          ],
        },
        {
          type: 'category',
          label: 'Architecture',
          link: { type: 'doc', id: 'reference/architecture/index' },
          items: [
            'reference/architecture/overview',
            'reference/architecture/data-path',
            {
              type: 'category',
              label: 'Network design',
              link: { type: 'doc', id: 'reference/architecture/design/index' },
              items: [
                'reference/architecture/design/l2-interconnect-fabric',
                'reference/architecture/design/l3-interconnect-fabric',
              ],
            },
          ],
        },
        {
          type: 'category',
          label: 'VPP dataplane',
          link: { type: 'doc', id: 'reference/vpp/index' },
          items: [
            'reference/vpp/uplink-configuration',
            'reference/vpp/technical-details',
            'reference/vpp/host-network',
          ],
        },
        'reference/faq',
        'reference/involved',
        {
          type: 'category',
          label: 'Attributions',
          link: { type: 'doc', id: 'reference/legal/index' },
          items: [
            'reference/legal/alp',
            'reference/legal/calicoctl',
            'reference/legal/cni',
            'reference/legal/confd',
            'reference/legal/felix',
            'reference/legal/node',
            'reference/legal/typha',
          ],
        },
      ],
    },
    'release-notes/index',
  ],

};