mkdocs.yml

site_name: NAIS
repo_url: https://github.com/nais/doc
site_url: https://doc.nais.io/
theme:
  name: material
  language: 'en'
  logo: assets/logo.png
  favicon: assets/logo.png
  custom_dir: custom_theme_overrides
  palette:
    scheme: preference
    primary: blue grey
    accent: deep purple
  features:
    - navigation.instant
    - navigation.tabs
extra:
  search:
    language: 'en'
extra_javascript:
  - amplitude_javascript/events.js
extra_css:
  - material_theme_stylesheet_overrides/uu.css
plugins:
  - search
markdown_extensions:
  - toc:
      permalink: True
  - admonition
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.superfences:
      preserve_tabs: true
  - pymdownx.highlight:
      css_class: codehilite
      linenums_style: pymdownx-inline
  - pymdownx.tasklist
  - pymdownx.smartsymbols
  - pymdownx.inlinehilite
  - pymdownx.tabbed
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
nav:
  - NAIS:
    - Introduction to NAIS: README.md
    - Getting started:
      - Access from laptop: basics/access.md
      - Teams: basics/teams.md
      - Your first NAIS application: basics/application.md
    - Clusters:
      - Google Cloud Platform: clusters/gcp.md
      - On-premises: clusters/on-premises.md
      - Migrating to GCP: clusters/migrating-to-gcp.md
      - Migrating databases to GCP: clusters/migrating-databases-to-gcp.md
      - Team namespaces: clusters/team-namespaces.md
      - Service discovery: clusters/service-discovery.md
    - NAIS Application:
      - Full example: nais-application/example.md
      - Reference: nais-application/application.md
      - Access policy: nais-application/access-policy.md
      - Automatic scaling: nais-application/automatic-scaling.md
      - Config reloading: nais-application/config-reloading.md
      - Ingress customization: nais-application/ingress.md
      - Linkerd / sidecar customization: nais-application/linkerd.md
      - Container security context / kernel capabilities: nais-application/securitycontext.md
      - Good practices: nais-application/good-practices.md
    - Naisjob:
      - Overview: naisjob/README.md
      - Full example: naisjob/example.md
      - Reference: naisjob/reference.md
    - Deploy:
      - NAIS deploy: deployment/README.md
      - Changing teams: deployment/change-team.md
      - Delete app: deployment/delete-app.md
      - Troubleshooting: deployment/troubleshooting.md
      - Allowed registries: deployment/allowed-registries.md
      - Manual deploy: deployment/manual.md
    - Observability:
      - Alerts:
        - Alerts Overview: observability/alerts/README.md
        - Full example: observability/alerts/example.md
        - Recommended: observability/alerts/recommended_alerts.md
        - Reference: observability/alerts/reference.md
      - Logs:
        - Logs Overview: observability/logs/README.md
        - Examples: observability/logs/examples.md
      - Metrics: observability/metrics.md
      - Tracing: observability/tracing.md
    - Persistence:
      - Responsibilities: persistence/responsibilities.md
      - Kafka: 
        - Overview: persistence/kafka/index.md
        - Application: persistence/kafka/application.md
        - Grafana metrics: persistence/kafka/metrics.md
        - Manage topics: persistence/kafka/manage_topics.md
        - Migrate from onprem: persistence/kafka/migrate_from_onprem.md
        - Avro and REST: persistence/kafka/avro_and_rest.md
        - Working with Kafka Offsets: persistence/kafka/offsets.md
        - FAQ: persistence/kafka/faq.md
      - Google Cloud Storage/Buckets: persistence/buckets.md
      - Google Cloud SQL (postgres): persistence/postgres.md
      - Google BigQuery: persistence/bigquery.md
      - ElasticSearch: persistence/elastic-search.md
      - InfluxDB: persistence/influxdb.md
      - S3 objectstore: persistence/objectstore.md
      - Redis: persistence/redis.md
      - On-premises disk: persistence/volume-storage.md
      - MQ: persistence/mq.md
      - MongoDB in GCP: persistence/mongodb-in-gcp.md
    - Security:
      - Auth:
        - Auth Overview: security/auth/README.md
        - Azure AD:
          - Intro: security/auth/azure-ad/README.md
          - Concepts: security/auth/azure-ad/concepts.md
          - Configuration: security/auth/azure-ad/configuration.md
          - Access Policy: security/auth/azure-ad/access-policy.md
          - Usage: security/auth/azure-ad/usage.md
          - Sidecar: security/auth/azure-ad/sidecar.md
          - FAQ / Troubleshooting: security/auth/azure-ad/faq-troubleshooting.md
          - Operations: security/auth/azure-ad/operations.md
          - Legacy: security/auth/azure-ad/legacy.md
        - ID-porten:
          - Intro: security/auth/idporten/README.md
          - Sidecar: security/auth/idporten/sidecar.md
        - Maskinporten:
          - Intro: security/auth/maskinporten/README.md
          - Client: security/auth/maskinporten/client.md
          - Scopes: security/auth/maskinporten/scopes.md
        - TokenX: security/auth/tokenx.md
      - Secrets:
        - Overview: security/secrets/README.md
        - Kubernetes Secrets: security/secrets/kubernetes-secrets.md
        - Google Secrets Manager: security/secrets/google-secrets-manager.md
        - Vault: security/secrets/vault.md
      - Anti-virus Scanning: security/antivirus.md
    - Addons:
      - Leader Election: addons/leader-election.md
      - Snorlax: addons/snorlax.md
      - Unleash (feature toggling): addons/unleash.md
      - Velero backup and restore: addons/velero-backup-and-restore.md
    - Legacy:
      - Sunset: legacy/sunset.md
      - AM/OpenAM: legacy/am.md
    - Appendix:
      - Zero-Trust Network Architecture: appendix/zero-trust.md
      - Ingress DNS setup: appendix/ingress-dns.md
      - Validation and autocompletion: appendix/json-schema.md
    - Support: support.md
  - naisdevice:
    - naisdevice Overview: device/README.md
    - Installation: device/install.md
    - Updating: device/update.md
    - Unenrolling: device/unenroll.md
    - naisdevice Troubleshooting: device/troubleshooting.md
    - Uninstall: device/uninstall.md
    - Available services: device/services.md
  - nais-cli:
    - Overview: cli/README.md
    - Installation: cli/install.md
    - Commands:
      - Aiven: cli/commands/aiven.md
      - Device: cli/commands/device.md
  - Laws and regulations:
    - Roles and responsibilities: legal/roles-responsibilities.md
    - Platform risk assessments (ROS): legal/nais-ros.md
    - Application risk assessments (ROS): legal/app-ros.md
    - Platform privacy impact assessments (PVK): legal/nais-pvk.md
    - Application privacy impact assessments (PVK): legal/app-pvk.md
    - Vendor Data Processor Agreements:
      - DPA Overview: legal/dpa/README.md
      - GCP Data Processor Agreement: legal/dpa/gcp-dpa.md
      - Azure Data Processor Agreement: legal/dpa/azure-dpa.md
      - Aiven Data Processor Agreement: legal/dpa/aiven-dpa.md
    - Arkivloven: legal/arkivloven.md
    - Sikkerhetsloven: legal/sikkerhetsloven.md