typhoon/mkdocs.yml

site_name: Typhoon
site_description: A minimal and free Kubernetes distribution
site_author: Dalton Hubble
copyright: Poseidon Laboratories
repo_name: poseidon/typhoon
repo_url: https://github.com/poseidon/typhoon
theme:
  name: material
  custom_dir: 'theme'
  features:
    - navigation.tabs
    - navigation.instant
  logo: 'img/spin.png'
  favicon: 'img/favicon.ico'
  icon:
    repo: fontawesome/brands/github-alt
  palette:
    primary: blue
    accent: pink
  font:
    text: 'Roboto Slab'
    code: 'Roboto Mono'
extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/poseidon
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/typhoon8s
markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
nav:
  - Home: 'index.md'
  - 'Announce': 'announce.md'
  - 'Architecture':
    - 'Concepts': 'architecture/concepts.md'
    - 'Operating Systems': 'architecture/operating-systems.md'
    - 'AWS': 'architecture/aws.md'
    - 'Azure': 'architecture/azure.md'
    - 'Bare-Metal': 'architecture/bare-metal.md'
    - 'DigitalOcean': 'architecture/digitalocean.md'
    - 'Google Cloud': 'architecture/google-cloud.md'
  - 'Fedora CoreOS':
    - 'AWS': 'fedora-coreos/aws.md'
    - 'Azure': 'fedora-coreos/azure.md'
    - 'Bare-Metal': 'fedora-coreos/bare-metal.md'
    - 'DigitalOcean': 'fedora-coreos/digitalocean.md'
    - 'Google Cloud': 'fedora-coreos/google-cloud.md'
  - 'Flatcar Linux':
    - 'AWS': 'flatcar-linux/aws.md'
    - 'Azure': 'flatcar-linux/azure.md'
    - 'Bare-Metal': 'flatcar-linux/bare-metal.md'
    - 'DigitalOcean': 'flatcar-linux/digitalocean.md'
    - 'Google Cloud': 'flatcar-linux/google-cloud.md'
  - 'Topics':
    - 'Maintenance': 'topics/maintenance.md'
    - 'Hardware': 'topics/hardware.md'
    - 'Security': 'topics/security.md'
    - 'Performance': 'topics/performance.md'
    - 'FAQ': 'topics/faq.md'
  - 'Advanced':
    - 'Overview': 'advanced/overview.md'
    - 'ARM64': 'advanced/arm64.md'
    - 'Customization': 'advanced/customization.md'
    - 'Nodes': 'advanced/nodes.md'
    - 'Worker Pools': 'advanced/worker-pools.md'
  - 'Addons':
    - 'Overview': 'addons/overview.md'
    - 'Nginx Ingress': 'addons/ingress.md'
    - 'Prometheus': 'addons/prometheus.md'
    - 'Grafana': 'addons/grafana.md'
    - 'fleetlock': 'addons/fleetlock.md'
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`site_name: Typhoon`
			`site_description: A minimal and free Kubernetes distribution`
			`site_author: Dalton Hubble`
Update Kubernetes from v1.19.2 to v1.19.3 * https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.19.md#v1193 2020-10-14 20:45:49 -07:00			`copyright: Poseidon Laboratories`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`repo_name: poseidon/typhoon`
			`repo_url: https://github.com/poseidon/typhoon`
Update mkdocs and material docs theme 2018-01-06 10:39:00 -08:00			`theme:`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`name: material`
Migrate from internal hosting to GitHub pages * Add Twitter card customizations that have been kept in an internal fork * Add CNAME needed for GitHub pages 2021-03-23 08:49:35 -07:00			`custom_dir: 'theme'`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`features:`
Update mkdocs-material from v5.5.12 to v6.0.1 * Update OS kernel, systemd, and docker verisons 2020-10-02 01:14:12 -07:00			`- navigation.tabs`
			`- navigation.instant`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`logo: 'img/spin.png'`
Update mkdocs and material docs theme 2018-01-06 10:39:00 -08:00			`favicon: 'img/favicon.ico'`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`icon:`
			`repo: fontawesome/brands/github-alt`
			`palette:`
			`primary: blue`
			`accent: pink`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`font:`
			`text: 'Roboto Slab'`
			`code: 'Roboto Mono'`
Organize docs by operating system 2018-04-23 19:55:28 -07:00			`extra:`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`social:`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`- icon: fontawesome/brands/github-alt`
			`link: https://github.com/poseidon`
			`- icon: fontawesome/brands/twitter`
			`link: https://twitter.com/typhoon8s`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`markdown_extensions:`
			`- admonition`
			`- codehilite`
			`- footnotes`
Fix requirements for docs builds 2018-10-07 19:26:55 +02:00			`- toc:`
			`permalink: true`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`- pymdownx.arithmatex`
Fix requirements for docs builds 2018-10-07 19:26:55 +02:00			`- pymdownx.betterem:`
			`smart_enable: all`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`- pymdownx.caret`
			`- pymdownx.critic`
			`- pymdownx.emoji:`
			`emoji_generator: !!python/name:pymdownx.emoji.to_svg`
			`- pymdownx.inlinehilite`
			`- pymdownx.magiclink`
			`- pymdownx.mark`
			`- pymdownx.smartsymbols`
			`- pymdownx.superfences`
Add Flatcar Linux ARM64 examples * Fix content tabs format for switching between example code blocks 2022-01-14 12:52:45 -08:00			`- pymdownx.tabbed:`
			`alternate_style: true`
Fix requirements for docs builds 2018-10-07 19:26:55 +02:00			`- pymdownx.tasklist:`
			`custom_checkbox: true`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`- pymdownx.tilde`
Change rooted links to absolute links for mkdocs v1.0 * mkdocs v1.0 now evaluates links beginning with / as absolute links that are only prepended with the site url 2018-10-07 19:57:16 +02:00			`nav:`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`- Home: 'index.md'`
Add Fedora Atomic announcement and improve docs 2018-04-26 02:41:04 -07:00			`- 'Announce': 'announce.md'`
Add architecture docs on operating systems 2018-04-24 01:10:40 -07:00			`- 'Architecture':`
Add Fedora Atomic announcement and improve docs 2018-04-26 02:41:04 -07:00			`- 'Concepts': 'architecture/concepts.md'`
Add architecture docs on operating systems 2018-04-24 01:10:40 -07:00			`- 'Operating Systems': 'architecture/operating-systems.md'`
Add an IPv6 address and forwarding rules on Google Cloud * Allowing serving IPv6 applications via Kubernetes Ingress on Typhoon Google Cloud clusters * Add `ingress_static_ipv6` output variable for use in AAAA DNS records 2018-10-28 14:17:12 -07:00			`- 'AWS': 'architecture/aws.md'`
			`- 'Azure': 'architecture/azure.md'`
			`- 'Bare-Metal': 'architecture/bare-metal.md'`
			`- 'DigitalOcean': 'architecture/digitalocean.md'`
			`- 'Google Cloud': 'architecture/google-cloud.md'`
Add Fedora CoreOS to issue template and docs * Update several Container Linux references to start referring to Flatcar Linux * Update docs and mentions of Fedora CoreOS 2020-03-25 00:31:18 -07:00			`- 'Fedora CoreOS':`
			`- 'AWS': 'fedora-coreos/aws.md'`
Add Fedora CoreOS Azure docs to site navigation * Fix missing Fedora CoreOS Azure docs 2020-04-28 19:54:37 -07:00			`- 'Azure': 'fedora-coreos/azure.md'`
Add Fedora CoreOS to issue template and docs * Update several Container Linux references to start referring to Flatcar Linux * Update docs and mentions of Fedora CoreOS 2020-03-25 00:31:18 -07:00			`- 'Bare-Metal': 'fedora-coreos/bare-metal.md'`
Fix typo in DigitalOcean docs title 2020-06-16 18:23:27 -07:00			`- 'DigitalOcean': 'fedora-coreos/digitalocean.md'`
Add Fedora CoreOS to issue template and docs * Update several Container Linux references to start referring to Flatcar Linux * Update docs and mentions of Fedora CoreOS 2020-03-25 00:31:18 -07:00			`- 'Google Cloud': 'fedora-coreos/google-cloud.md'`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`- 'Flatcar Linux':`
			`- 'AWS': 'flatcar-linux/aws.md'`
			`- 'Azure': 'flatcar-linux/azure.md'`
			`- 'Bare-Metal': 'flatcar-linux/bare-metal.md'`
Fix typo in DigitalOcean docs title 2020-06-16 18:23:27 -07:00			`- 'DigitalOcean': 'flatcar-linux/digitalocean.md'`
Upgrade docs packages and refresh content * Promote DigitalOcean from alpha to beta for Fedora CoreOS and Flatcar Linux * Upgrade mkdocs-material and PyPI packages for docs * Replace docs mentions of Container Linux with Flatcar Linux and move docs/cl to docs/flatcar-linux * Deprecate CoreOS Container Linux support. Its still usable for some time, but start removing docs 2020-05-20 22:53:51 -07:00			`- 'Google Cloud': 'flatcar-linux/google-cloud.md'`
README: Add IRC link, CHANGES.md, and minor fixes 2017-09-23 13:02:18 -07:00			`- 'Topics':`
Add maintenance docs with upgrade policies * Add best practices for maintenance * Describe blue-green replacement strategy * Mention unsupported in-place edit and node replacement strategies 2018-01-09 06:54:44 -08:00			`- 'Maintenance': 'topics/maintenance.md'`
Add Ubiquity EdgeRouter documentation 2017-10-16 02:17:35 -07:00			`- 'Hardware': 'topics/hardware.md'`
README: Add IRC link, CHANGES.md, and minor fixes 2017-09-23 13:02:18 -07:00			`- 'Security': 'topics/security.md'`
Add docs on provision time and network performance 2017-10-03 23:44:26 -07:00			`- 'Performance': 'topics/performance.md'`
Add architecture docs on operating systems 2018-04-24 01:10:40 -07:00			`- 'FAQ': 'topics/faq.md'`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`- 'Advanced':`
Add support for worker pools on google-cloud * Set defaults for internal worker module's count, machine_type, and os_image * Allow "pools" of homogeneous workers to be created using the google-cloud/kubernetes/workers module 2018-02-26 14:06:18 -08:00			`- 'Overview': 'advanced/overview.md'`
Add experimental Fedora CoreOS arm64 support on AWS * Add experimental `arch` variable to Fedora CoreOS AWS, accepting amd64 (default) or arm64 to support native arm64/aarch64 clusters or mixed/hybrid clusters with a worker pool of arm64 workers * Add `daemonset_tolerations` variable to cluster module (experimental) * Add `node_taints` variable to workers module * Requires flannel CNI and experimental Poseidon-built arm64 Fedora CoreOS AMIs (published to us-east-1, us-east-2, and us-west-1) WARN: * Our AMIs are experimental, may be removed at any time, and will be removed when Fedora CoreOS publishes official arm64 AMIs. Do NOT use in production Related: * https://github.com/poseidon/typhoon/pull/682 2020-11-08 10:51:42 -08:00			`- 'ARM64': 'advanced/arm64.md'`
Add concepts, tutorials, and faq docs * Add bare-metal tutorial * Add DigitalOcean tutorial * Add Google Cloud tutorial 2017-08-06 18:27:45 -07:00			`- 'Customization': 'advanced/customization.md'`
Allow custom initial node taints on worker pool nodes * Add `node_taints` variable to worker modules to set custom initial node taints on cloud platforms that support auto-scaling worker pools of heterogeneous nodes (i.e. AWS, Azure, GCP) * Worker pools could use custom `node_labels` to allowed workloads to select among differentiated nodes, while custom `node_taints` allows a worker pool's nodes to be tainted as special to prevent scheduling, except by workloads that explicitly tolerate the taint * Expose `daemonset_tolerations` in AWS, Azure, and GCP kubernetes cluster modules, to determine whether `kube-system` components should tolerate the custom taint (advanced use covered in docs) Rel: #550, #663 Closes #429 2021-04-11 12:08:56 -07:00			`- 'Nodes': 'advanced/nodes.md'`
Add support for worker pools on google-cloud * Set defaults for internal worker module's count, machine_type, and os_image * Allow "pools" of homogeneous workers to be created using the google-cloud/kubernetes/workers module 2018-02-26 14:06:18 -08:00			`- 'Worker Pools': 'advanced/worker-pools.md'`
Organize docs by operating system 2018-04-23 19:55:28 -07:00			`- 'Addons':`
			`- 'Overview': 'addons/overview.md'`
			`- 'Nginx Ingress': 'addons/ingress.md'`
			`- 'Prometheus': 'addons/prometheus.md'`
			`- 'Grafana': 'addons/grafana.md'`
Add fleetlock docs and links to addons * Add links to fleetlock for Fedora CoreOS reboot coordination * https://github.com/poseidon/fleetlock 2020-08-27 23:25:44 -07:00			`- 'fleetlock': 'addons/fleetlock.md'`