Update Astarte Kubernetes Operator documentation

astarte-platform · Jan 16, 2024 · e84725e · e84725e
1 parent af0965c
commit e84725e
Show file tree

Hide file tree

Showing 146 changed files with 12,540 additions and 0 deletions.
diff --git a/astarte-kubernetes-operator/refs/tags/v23.5.1/000-upgrade_index.html b/astarte-kubernetes-operator/refs/tags/v23.5.1/000-upgrade_index.html
@@ -0,0 +1,156 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="x-ua-compatible" content="ie=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="generator" content="ExDoc v0.29.0">
+    <meta name="project" content="Astarte Operator v23.5.1">
+
+    <title>Upgrade Procedures — Astarte Operator v23.5.1</title>
+    <link rel="stylesheet" href="dist/html-elixir-2YOS5DIE.css" />
+
+    <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
+    <script src="dist/handlebars.templates-X7YVL3G2.js"></script>
+    <script src="dist/sidebar_items-3AF50CD1.js"></script>
+
+      <script src="../common_vars.js"></script>
+
+    <script async src="dist/html-XN2TSG4M.js"></script>
+
+
+  </head>
+  <body data-type="extras" class="page-extra">
+    <script>
+
+      try {
+        var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
+
+        if (settings.theme === 'dark' ||
+           ((settings.theme === 'system' || settings.theme == null) &&
+             window.matchMedia('(prefers-color-scheme: dark)').matches)
+           ) {
+          document.body.classList.add('dark')
+        }
+      } catch (error) { }
+    </script>
+
+<div class="main">
+
+<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
+  <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
+</button>
+
+<section class="sidebar">
+  <form class="sidebar-search" action="search.html">
+    <button type="submit" class="search-button" aria-label="Submit Search">
+      <i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
+    </button>
+    <button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
+      <i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
+    </button>
+    <label class="search-label">
+      <p class="sr-only">Search</p>
+      <input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
+    </label>
+  </form>
+
+  <div class="autocomplete">
+    <div class="autocomplete-results">
+    </div>
+  </div>
+
+  <div class="sidebar-header">
+
+      <a href="https://docs.astarte-platform.org/astarte-kubernetes-operator/23.5/">
+        <img src="assets/logo.png" alt="Astarte Operator" class="sidebar-projectImage">
+      </a>
+
+    <div class="sidebar-projectDetails">
+      <a href="https://docs.astarte-platform.org/astarte-kubernetes-operator/23.5/" class="sidebar-projectName" translate="no">
+Astarte Operator
+      </a>
+      <strong class="sidebar-projectVersion" translate="no">
+        v23.5.1
+      </strong>
+    </div>
+    <ul class="sidebar-listNav">
+      <li><a id="extras-list-link" href="#full-list">Pages</a></li>
+
+
+    </ul>
+  </div>
+
+  <div class="gradient"></div>
+  <ul id="full-list" class="sidebar-fullList"></ul>
+</section>
+
+<section class="content">
+  <output role="status" id="toast"></output>
+  <div class="content-outer">
+    <div id="content" class="content-inner">
+
+<h1>
+<button class="settings display-settings">
+  <i class="ri-settings-3-line"></i>
+  <span class="sr-only">Settings</span>
+</button>
+
+
+    <a href="https://github.com/astarte-platform/astarte-kubernetes-operator/blob/release-23.5/docs/documentation/pages/upgrade/000-upgrade_index.md#L1" title="View Source" class="view-source" rel="help">
+      <i class="ri-code-s-slash-line" aria-hidden="true"></i>
+      <span class="sr-only">View Source</span>
+    </a>
+
+  <span>Upgrade Procedures</span>
+</h1>
+
+<p>The procedure for upgrading Astarte and Astarte Operator depends on the version you want to upgrade
+from.</p><p>After Astarte Operator v1.0.x, a change in the versioning scheme was introduced.
+This does <strong>not</strong> have any impact on the Astarte version. Refer to the
+<a href="https://github.com/astarte-platform/astarte-kubernetes-operator/issues/306">related issue</a>
+for more information.</p><p>Find below the upgrade guides for your Astarte cluster:</p><ul><li>to upgrade from v0.10 to v0.11, click <a href="010-upgrade_010_011.html">here</a></li><li>to upgrade from v0.11 to v1.0, click <a href="020-upgrade_011_10.html">here</a></li><li>to upgrade from v1.0.0 to v1.0.x, click <a href="030-upgrade_100_10x.html">here</a></li><li>to upgrade from v1.0.x to v22.11, click <a href="040-upgrade_10x_2211.html">here</a></li><li>to upgrade from v22.11.x to v23.5, click <a href="050-upgrade_2211_235.html">here</a></li></ul>
+<div class="bottom-actions">
+  <div class="bottom-actions-item">
+
+      <a href="095-advanced_operations.html" class="bottom-actions-button" rel="prev">
+        <span class="subheader">
+          ← Previous Page
+        </span>
+        <span class="title">
+Advanced operations
+        </span>
+      </a>
+
+  </div>
+  <div class="bottom-actions-item">
+
+      <a href="010-upgrade_010_011.html" class="bottom-actions-button" rel="next">
+        <span class="subheader">
+          Next Page →
+        </span>
+        <span class="title">
+Upgrade v0.10-v0.11
+        </span>
+      </a>
+
+  </div>
+</div>
+      <footer class="footer">
+
+        <p>
+          Built using
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.0) for the
+
+            <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
+
+        </p>
+      </footer>
+    </div>
+  </div>
+</section>
+</div>
+
+
+  </body>
+</html>
diff --git a/astarte-kubernetes-operator/refs/tags/v23.5.1/001-intro_administrator.html b/astarte-kubernetes-operator/refs/tags/v23.5.1/001-intro_administrator.html
@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="x-ua-compatible" content="ie=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="generator" content="ExDoc v0.29.0">
+    <meta name="project" content="Astarte Operator v23.5.1">
+
+    <title>Introduction — Astarte Operator v23.5.1</title>
+    <link rel="stylesheet" href="dist/html-elixir-2YOS5DIE.css" />
+
+    <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
+    <script src="dist/handlebars.templates-X7YVL3G2.js"></script>
+    <script src="dist/sidebar_items-3AF50CD1.js"></script>
+
+      <script src="../common_vars.js"></script>
+
+    <script async src="dist/html-XN2TSG4M.js"></script>
+
+
+  </head>
+  <body data-type="extras" class="page-cheatmd">
+    <script>
+
+      try {
+        var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
+
+        if (settings.theme === 'dark' ||
+           ((settings.theme === 'system' || settings.theme == null) &&
+             window.matchMedia('(prefers-color-scheme: dark)').matches)
+           ) {
+          document.body.classList.add('dark')
+        }
+      } catch (error) { }
+    </script>
+
+<div class="main">
+
+<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
+  <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
+</button>
+
+<section class="sidebar">
+  <form class="sidebar-search" action="search.html">
+    <button type="submit" class="search-button" aria-label="Submit Search">
+      <i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
+    </button>
+    <button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
+      <i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
+    </button>
+    <label class="search-label">
+      <p class="sr-only">Search</p>
+      <input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
+    </label>
+  </form>
+
+  <div class="autocomplete">
+    <div class="autocomplete-results">
+    </div>
+  </div>
+
+  <div class="sidebar-header">
+
+      <a href="https://docs.astarte-platform.org/astarte-kubernetes-operator/23.5/">
+        <img src="assets/logo.png" alt="Astarte Operator" class="sidebar-projectImage">
+      </a>
+
+    <div class="sidebar-projectDetails">
+      <a href="https://docs.astarte-platform.org/astarte-kubernetes-operator/23.5/" class="sidebar-projectName" translate="no">
+Astarte Operator
+      </a>
+      <strong class="sidebar-projectVersion" translate="no">
+        v23.5.1
+      </strong>
+    </div>
+    <ul class="sidebar-listNav">
+      <li><a id="extras-list-link" href="#full-list">Pages</a></li>
+
+
+    </ul>
+  </div>
+
+  <div class="gradient"></div>
+  <ul id="full-list" class="sidebar-fullList"></ul>
+</section>
+
+<section class="content">
+  <output role="status" id="toast"></output>
+  <div class="content-outer">
+    <div id="content" class="content-inner">
+
+<h1>
+<button class="settings display-settings">
+  <i class="ri-settings-3-line"></i>
+  <span class="sr-only">Settings</span>
+</button>
+
+
+    <a href="https://github.com/astarte-platform/astarte-kubernetes-operator/blob/release-23.5/docs/documentation/pages/administrator/001-intro_administrator.cheatmd#L1" title="View Source" class="view-source" rel="help">
+      <i class="ri-code-s-slash-line" aria-hidden="true"></i>
+      <span class="sr-only">View Source</span>
+    </a>
+
+  <span>Introduction</span>
+</h1>
+
+<img src="./assets/mascotte_k8s.svg" align="right" width="25%" style="border:20px transparent solid"/><p>Astarte Kubernetes Operator runs and manages an Astarte Cluster in a Kubernetes Cluster. It is meant
+to work on any Managed Kubernetes installation, and leverages a number of Kubernetes features to
+ensure Astarte runs as smooth as possible. It also handles upgrades, monitoring, and more.</p><p>This guide is meant for System Administrators who need to deal with Astarte clusters installation,
+maintenance and upgrade. The guide will cover prerequisites, installation in different supported
+environments, and common maintenance operations.</p><p>Astarte Operator is the foundation of any Astarte installation, and you can find more information
+about it in the following sections.</p><p>Before you begin, it is fundamental you are familiar with <a href="https://docs.astarte-platform.org/astarte/latest/001-intro_architecture.html">Astarte's architecture, design and
+concepts</a>, especially
+for what concerns its components and 3rd party services.</p><section class="h3"><h3 id="compatibility-matrix" class="section-heading">
+  <a href="#compatibility-matrix" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
+  <p class="sr-only">compatibility-matrix</p>
+  </a>
+  Compatibility Matrix
+</h3>
+<table><thead><tr><th style="text-align: left;">Astarte Operator Version</th><th style="text-align: left;">Astarte Version</th><th style="text-align: left;">Kubernetes Version</th></tr></thead><tbody><tr><td style="text-align: left;">v1.0.0</td><td style="text-align: left;">v0.11 - v1.0</td><td style="text-align: left;">v1.19+</td></tr><tr><td style="text-align: left;">v1.0.x</td><td style="text-align: left;">v0.11 - v1.0</td><td style="text-align: left;">v1.19+</td></tr><tr><td style="text-align: left;">v22.11</td><td style="text-align: left;">v1.0+</td><td style="text-align: left;">v1.22+</td></tr><tr><td style="text-align: left;">v23.5</td><td style="text-align: left;">v1.0+</td><td style="text-align: left;">v1.22+</td></tr></tbody></table><p><strong>Note</strong>: starting from Kubernetes 1.22, the AstarteVoyagerIngress resource is not supported
+anymore.</p></section>
+<div class="bottom-actions">
+  <div class="bottom-actions-item">
+
+  </div>
+  <div class="bottom-actions-item">
+
+      <a href="010-system_requirements.html" class="bottom-actions-button" rel="next">
+        <span class="subheader">
+          Next Page →
+        </span>
+        <span class="title">
+System Requirements
+        </span>
+      </a>
+
+  </div>
+</div>
+      <footer class="footer">
+
+        <p>
+          Built using
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.0) for the
+
+            <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
+
+        </p>
+      </footer>
+    </div>
+  </div>
+</section>
+</div>
+
+
+  </body>
+</html>