mkdocs.yml

strict: false
site_name: CAST AI Documentation
theme:
  name: 'material'
  favicon: img/favicon.ico
  custom_dir: overrides
  logo: img/cast-logo-dark-blue.svg
  palette:
    primary: white
    accent: indigo
  font:
    text: Nimbus Sans
  features:
    - navigation.indexes
extra_css:
  - stylesheets/extra.css
site_url: https://docs.cast.ai
repo_url: https://github.com/castai/docs
edit_uri: https://github.com/castai/docs/edit/main/docs/
markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: true
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde


extra:
  generator: false
  homepage: https://cast.ai/
  analytics:
    provider: google
    property: UA-162225268-1

nav:
  - 'Introduction': index.md
  - 'Getting started':
      - getting-started/overview.md
      - 'AWS EKS':
        - 'Connect and onboard EKS': getting-started/eks/eks.md
        - 'Remove CAST AI from EKS': getting-started/eks/remove-from-eks.md
      - 'GCP GKE':
        - 'Connect and onboard GKE': getting-started/gke/gke.md
        - 'Remove CAST AI from GKE': getting-started/gke/remove-from-gke.md
        - 'Onboard Organization using GCP Marketplace': getting-started/gke/gcp-marketplace-onboarding.md
      - 'Azure AKS':
        - 'Connect and onboard AKS': getting-started/aks/aks.md
        - 'Remove CAST AI from AKS': getting-started/aks/remove-from-aks.md
      - 'kOps':
        - 'Connect and onboard kOps': getting-started/kops/kops.md
        - 'Remove CAST AI from kOps': getting-started/kops/remove-from-kops.md
  - 'Product overview':
      - 'Console':
          - product-overview/console/clusters.md
          - product-overview/console/nodes.md
          - product-overview/console/audit-log.md
          - product-overview/console/autoscaler.md
          - 'Cost report': product-overview/console/cost-report.md
          - product-overview/console/logs.md
          - product-overview/console/api.md
          - product-overview/console/security-insights.md
      - 'Autoscaler':
          - product-overview/autoscaler/index.md
          - product-overview/autoscaler/features/subnets.md
      - 'Rebalancing':
          - product-overview/rebalancing/index.md
          - product-overview/rebalancing/preparation.md
          - 'Rebalance your cluster': product-overview/rebalancing/run.md
      - 'Hosted Components': product-overview/hosted-components.md
      - 'Security Report': product-overview/security.md
  - 'Guides':
      - guides/external-clusters.md
      - 'Pod placement': guides/pod-placement.md
      - guides/volumes.md
      - guides/connect-to-node.md
      - guides/autoscaling-policies.md
      - 'Start saving quickly': guides/start-saving-quickly.md
      - guides/hpa.md
      - guides/spot.md
      - guides/vpa.md
      - guides/gpu.md
      - 'Node kernel tuning': guides/node-kernel-tuning.md
      - guides/evictor.md
      - 'Cluster controller': guides/cluster-controller.md
      - 'Kvisor security': guides/kvisor-security.md
      - 'Node Configuration': guides/node-configuration.md
      - 'Mutating Admission Webhook': guides/mutating-admision-webhook.md
      - 'Cluster metrics': guides/metrics.md
      - 'Agent status monitoring': guides/agent-monitoring.md
      - 'Kubernetes permissions': guides/kubernetes-permissions.md
      - 'Cloud permissions': guides/cloud-permissions.md
      - 'Custom secret management': guides/custom-secret-management.md
      - guides/webhooks.md
  - 'API':
      - 'Introduction': api/overview.md
      - 'Authentication': api/authentication.md
      - 'Specification': api/specification.md
      - 'Terraform provider': api/terraform-provider.md
      - 'CLI': api/cli.md
  - 'Administration':
      - 'Configure payment details': administration/configure-payment-method.md
  - 'Release notes': "https://cast.ai/release-notes/"
  - 'Service status': "https://status.cast.ai/"
  - 'CAST AI GitHub': "https://github.com/castai"
  - 'CAST AI Community Slack': "https://join.slack.com/t/castai-community/shared_invite/zt-nwtbsbqq-dWOBiUgLtIGMsUSup7Xksw"
  - 'CAST AI Console': "https://console.cast.ai"
  - 'CAST AI on Medium': "https://castai.medium.com/"
  - 'CAST AI Twitter': "https://twitter.com/cast_ai"