Add documentation for VPA and sig-autoscaling

.github/actions/mkdocs/Dockerfile

@@ -0,0 +1,8 @@
+FROM squidfunk/mkdocs-material:9.5
+
+COPY action.sh /action.sh
+
+RUN apk add --no-cache bash \
+  && chmod +x /action.sh
+
+ENTRYPOINT ["/action.sh"]

.github/actions/mkdocs/action.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+# Copyright 2024 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -ex
+
+REQUIREMENTS="${GITHUB_WORKSPACE}/docs/requirements.txt"
+
+if [ -f "${REQUIREMENTS}" ]; then
+    pip install -r "${REQUIREMENTS}"
+fi
+
+if [ -n "${GITHUB_TOKEN}" ]; then
+    remote_repo="https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
+elif [ -n "${PERSONAL_TOKEN}" ]; then
+    remote_repo="https://x-access-token:${PERSONAL_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
+fi
+
+git config --global user.name "$GITHUB_ACTOR"
+git config --global user.email "[email protected]"
+
+mkdocs build --config-file "${GITHUB_WORKSPACE}/docs/mkdocs-root.yml"
+mkdocs build --config-file "${GITHUB_WORKSPACE}/docs/mkdocs-vertical-pod-autoscaler.yml"
+
+git clone --branch=gh-pages --depth=1 "${remote_repo}" gh-pages
+cd gh-pages
+
+# # copy current index file index.yaml and OWNERS before any change
+temp_worktree=$(mktemp -d)
+cp --force "index.yaml" "$temp_worktree/index.yaml"
+cp --force "OWNERS" "$temp_worktree/OWNERS"
+
+# remove current content in branch gh-pages
+git rm -r .
+# copy new doc.
+cp -r ../site/* .
+
+# restore chart index and OWNERS
+cp "$temp_worktree/index.yaml" .
+cp "$temp_worktree/OWNERS" .
+
+# commit changes
+git add .
+git commit -m "Deploy GitHub Pages"
+git push --force --quiet "${remote_repo}" gh-pages > /dev/null 2>&1

.github/actions/mkdocs/action.yml

@@ -0,0 +1,9 @@
+# action.yml
+name: 'Deploy MkDocs'
+description: 'Deploys MkDocs site'
+branding:
+  icon: 'arrow-up-circle'
+  color: 'orange'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

.github/workflows/docs.yaml

@@ -0,0 +1,53 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+
+  changes:
+    permissions:
+      contents: read  # for dorny/paths-filter to fetch a list of changed files
+      pull-requests: read  # for dorny/paths-filter to read pull requests
+    runs-on: ubuntu-latest
+    if: |
+      (github.repository == 'kubernetes/autoscaler')
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+      charts: ${{ steps.filter.outputs.charts }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
+
+      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: filter
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          filters: |
+            docs:
+             - 'docs/**/*'
+  docs:
+    name: Update
+    runs-on: ubuntu-latest
+    needs:
+      - changes
+    if: |
+      (github.repository == 'kubernetes/autoscaler') &&
+      (needs.changes.outputs.docs == 'true')
+    permissions:
+      contents: write # needed to write releases
+
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
+
+      - name: Deploy
+        uses: ./.github/actions/mkdocs
+        env:
+          PERSONAL_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -34,3 +34,6 @@ bin/
 
 # vertical pod autoscaler test output
 vertical-pod-autoscaler/e2e/v1*/workspace/
+
+# documentation output
+site/

docs/mkdocs-root.yml

@@ -0,0 +1,71 @@
+site_name: sig-autoscaling
+repo_url: https://github.com/kubernetes/autoscaler
+site_url: https://kubernetes.github.io/autoscaler
+docs_dir: ./root/
+site_dir : ../site/
+
+# Extensions
+markdown_extensions:
+  - admonition
+  - abbr
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - md_in_html
+  - toc:
+      # insert a blank space before the character
+      permalink: " ¶"
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.magiclink
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - 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
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+theme:
+  name: material
+  favicon: images/k8s-favicon.png
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.instant
+    - navigation.sections
+
+  palette:
+    primary: "#326CE5"
+
+  include_sidebar: true
+
+  icon:
+    repo: fontawesome/brands/github
+
+plugins:
+  - awesome-pages
+  - minify:
+      minify_html: true
+
+nav:
+  - Welcome:
+      - Welcome: "index.md"

docs/mkdocs-vertical-pod-autoscaler.yml

@@ -0,0 +1,79 @@
+site_name: Vertical Pod Autoscaler
+repo_name: "kubernetes/autoscaler"
+repo_url: https://github.com/kubernetes/autoscaler
+site_url: https://kubernetes.github.io/autoscaler
+docs_dir: ./vertical-pod-autoscaler/
+site_dir : ../site/vertical-pod-autoscaler/
+
+
+# Extensions
+markdown_extensions:
+  - admonition
+  - abbr
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - md_in_html
+  - toc:
+      # insert a blank space before the character
+      permalink: " ¶"
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - 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
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+theme:
+  name: material
+  favicon: images/k8s-favicon.png
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.instant
+    - navigation.sections
+
+  palette:
+    primary: "#326CE5"
+
+  include_sidebar: true
+
+  icon:
+    repo: fontawesome/brands/github
+
+plugins:
+  - search
+  - awesome-pages
+  - minify:
+      minify_html: true
+
+nav:
+  - Welcome:
+      - Welcome: "index.md"
+  - Installation: "installation/index.md"
+  - Features:
+      - Limit Control: "limitcontrol/index.md"
+  - Examples: "examples/index.md"
+  - Known Limitations: "limitations/index.md"
+  - FAQ: "faq.md"

docs/requirements.txt

@@ -0,0 +1,4 @@
+mkdocs-material==9.5.45
+mkdocs-awesome-pages-plugin==2.9.3
+mkdocs-minify-plugin==0.7.1
+mkdocs-redirects==1.2.1

docs/root/index.md

@@ -0,0 +1,11 @@
+# Overview
+
+SIG-autoscaling covers development and maintenance of components for automated scaling in Kubernetes. This includes automated vertical and horizontal pod autoscaling, initial resource estimation, cluster-proportional system component autoscaling, and autoscaling of Kubernetes clusters themselves.
+
+## Projects
+
+- [Addon Resizer](https://github.com/kubernetes/autoscaler/tree/master/addon-resizer)
+- [Cluster Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler)
+- [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
+- [Karpenter](https://karpenter.sh)
+- <a href="./vertical-pod-autoscaler/">Vertical Pod Autoscaler</a>