Skip to content

Commit

Permalink
Deployed 3c2be2b to improve-docs with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@stakater-user
stakater-user committed Jan 17, 2025
1 parent 1fffea8 commit 914672f
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 89 deletions.
6 changes: 3 additions & 3 deletions improve-docs/architecture/concepts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4167,11 +4167,11 @@ <h2 id="template">Template<a class="headerlink" href="#template" title="Permanen
<h2 id="template-instance-ti">Template Instance (TI)<a class="headerlink" href="#template-instance-ti" title="Permanent link">#</a></h2>
<p>A <strong>Template Instance</strong> is a concrete implementation of a <strong>Template</strong>, created with specific parameters tailored for a particular tenant or use case. It generates actual Kubernetes resources based on the defined template.</p>
<h2 id="template-group-instance-tgi">Template Group Instance (TGI)<a class="headerlink" href="#template-group-instance-tgi" title="Permanent link">#</a></h2>
<p>A <strong>Template Group Instance</strong> is a collection of <strong>Template Instances</strong> that are deployed together as a unified set of configurations. It simplifies managing multiple interdependent resources for complex tenant setups.</p>
<p>A <strong>Template Group Instance</strong> works on a particular set of namespaces based on the mentioned labels, taking <strong>Template</strong> as a reference for the resources to be deployed. It simplifies managing multiple interdependent resources for complex tenant setups.</p>
<h2 id="extensions">Extensions<a class="headerlink" href="#extensions" title="Permanent link">#</a></h2>
<p><strong>Extensions</strong> enhance MTO functionality by integrating external services like ArgoCD. They allow seamless synchronization of repositories and configuration of AppProjects for tenants, extending multi-tenant workflows.</p>
<p><strong>Extensions</strong> enhance MTO functionality by integrating external services like ArgoCD. They allow seamless configuration of AppProjects for tenants, extending multi-tenant workflows.</p>
<h2 id="resource-supervisor">Resource Supervisor<a class="headerlink" href="#resource-supervisor" title="Permanent link">#</a></h2>
<p>The <strong>Resource Supervisor</strong> manages the hibernation of deployments and stateful sets, enabling scheduled scaling down during inactivity and scaling up during active periods, optimizing resource utilization and reducing costs.</p>
<p>The <strong>Resource Supervisor</strong> manages the hibernation of deployments and stateful sets, enabling scaling down during user defined schedule or by manual trigger, optimizing resource utilization and reducing costs.</p>



Expand Down
33 changes: 6 additions & 27 deletions improve-docs/crds-api-reference/template.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3963,15 +3963,6 @@ <h3 class="dropdown-content-column-title">Open Source</h3>
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#mandatory-and-optional-templates" class="md-nav__link">
<span class="md-ellipsis">
Mandatory and Optional Templates
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -4301,15 +4292,6 @@ <h3 class="dropdown-content-column-title">Open Source</h3>
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#mandatory-and-optional-templates" class="md-nav__link">
<span class="md-ellipsis">
Mandatory and Optional Templates
</span>
</a>

</li>

</ul>
Expand All @@ -4334,20 +4316,19 @@ <h1 id="template">Template<a class="headerlink" href="#template" title="Permanen
<p>Templates are used to initialize Namespaces, share common resources across namespaces, and map secrets/configmaps from one namespace to other namespaces.</p>
<p>They are tracked by TemplateInstances in each Namespace they are applied to.</p>
<p>They can contain pre-defined parameters such as <code>${namespace}</code>/<code>${tenant}</code> or user-defined <code>${MY_PARAMETER}</code> that can be specified within an <code>TemplateInstance</code>.</p>
<p>// TODO: Clarify text in second sentence.
Also, you can define custom variables in <code>Template</code> and <code>TemplateInstance</code>. The parameters defined in <code>TemplateInstance</code> are overwritten the values defined in <code>Template</code>.</p>
<p>Also, you can define custom variables in <code>Template</code> and <code>TemplateInstance</code>. The parameters defined in <code>Templates</code> are overwritten the values defined in <code>TemplateInstance</code> and <code>TemplateGroupInstance</code>.</p>
<h2 id="specification">Specification<a class="headerlink" href="#specification" title="Permanent link">#</a></h2>
<p><code>Template</code> Custom Resource (CR) supports three key methods for defining and managing resources: <code>manifests</code>, <code>helm</code>, and <code>resource mapping</code>. Let’s dive into each method, their differences, and their use cases:</p>
<h3 id="1-manifests">1. Manifests<a class="headerlink" href="#1-manifests" title="Permanent link">#</a></h3>
<p>This approach uses raw Kubernetes manifests (YAML files) that specify resources directly in the template.</p>
<h4 id="how-it-works">How It Works<a class="headerlink" href="#how-it-works" title="Permanent link">#</a></h4>
<ul>
<li>The template includes the actual YAML specifications of resources like <code>Deployment</code>, <code>Service</code>, <code>ConfigMap</code>, etc.</li>
<li>These manifests are applied as-is or with minor parameter substitutions (e.g., names, labels, or annotations). // TODO: Is it completely true?</li>
<li>These manifests are applied as-is or with minor parameter substitutions (e.g., names, labels, annotations or user defined parameters).</li>
</ul>
<h4 id="use-cases">Use Cases<a class="headerlink" href="#use-cases" title="Permanent link">#</a></h4>
<ul>
<li>Best for straightforward and simple resources where you don’t need advanced templating logic or dependency management.</li>
<li>Best for straightforward and simple resources where you don't need advanced templating logic or dependency management.</li>
<li>Ideal when the resource definitions are static or have minimal customization needs.</li>
</ul>
<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h4>
Expand Down Expand Up @@ -4398,8 +4379,8 @@ <h3 id="2-helm">2. Helm<a class="headerlink" href="#2-helm" title="Permanent lin
<p>This method integrates Helm charts into the template, allowing you to leverage Helm's templating capabilities and package management.</p>
<h4 id="how-it-works_1">How It Works<a class="headerlink" href="#how-it-works_1" title="Permanent link">#</a></h4>
<ul>
<li>The template references a Helm chart (local or remote). // TODO: Does local make any sense here?</li>
<li>Values for the Helm chart can be passed as parameters within the template.</li>
<li>The <code>Template</code> references a Helm chart.</li>
<li>Values for the Helm chart can be passed by the <code>values</code> field.</li>
<li>The Helm chart generates the necessary Kubernetes resources dynamically at runtime.</li>
</ul>
<h4 id="use-cases_1">Use Cases<a class="headerlink" href="#use-cases_1" title="Permanent link">#</a></h4>
Expand Down Expand Up @@ -4427,7 +4408,7 @@ <h3 id="3-resource-mapping">3. Resource Mapping<a class="headerlink" href="#3-re
<p>This approach maps secrets and configmaps from one tenant's namespace to another tenant's namespace, or within a tenant's namespace.</p>
<h4 id="how-it-works_2">How It Works<a class="headerlink" href="#how-it-works_2" title="Permanent link">#</a></h4>
<ul>
<li>The template contains mappings to pre-existing resources.</li>
<li>The template contains mappings to pre-existing resources (secrets and configmaps only).</li>
</ul>
<h4 id="use-cases_2">Use Cases<a class="headerlink" href="#use-cases_2" title="Permanent link">#</a></h4>
<ul>
Expand All @@ -4448,8 +4429,6 @@ <h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permane
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">configmap-c1</span>
<span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">namespace-n2</span>
</code></pre></div>
<h2 id="mandatory-and-optional-templates">Mandatory and Optional Templates<a class="headerlink" href="#mandatory-and-optional-templates" title="Permanent link">#</a></h2>
<p>Templates can either be mandatory or optional. By default, all Templates are optional. Cluster Admins can make Templates mandatory by adding them to the <code>spec.templateInstances</code> array within the Tenant configuration. All Templates listed in <code>spec.templateInstances</code> will always be instantiated within every <code>Namespace</code> that is created for the respective Tenant.</p>



Expand Down
2 changes: 1 addition & 1 deletion improve-docs/search/search_index.json
View file

Large diffs are not rendered by default.

116 changes: 58 additions & 58 deletions improve-docs/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,234 +2,234 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.stakater.com/mto/improve-docs/index.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/changelog.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/eula.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/pricing.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/troubleshooting.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/about/benefits.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/about/key-features.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/about/use-cases.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/architecture/architecture.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/architecture/concepts.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/extensions.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/integration-config.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/quota.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/resource-supervisor.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/template-group-instance.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/template-instance.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/template.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/crds-api-reference/tenant.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/explanation/console.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/explanation/logs-metrics.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/explanation/multi-tenancy-vault.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/explanation/template.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/explanation/templated-metadata-values.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/explanation/tenant-policies/networking.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/configuring-multitenant-network-isolation.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/copying-resources.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/custom-metrics.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/custom-roles.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/deploying-private-helm-charts.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/deploying-templates.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/distributing-secrets-using-sealed-secret-template.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/enabling-multi-tenancy-argocd.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/enabling-multi-tenancy-vault.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/enabling-openshift-dev-workspace.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/extend-default-roles.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/graph-visualization.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/hibernation-workflow.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/integrating-external-keycloak.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/integrating-vault.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/keycloak.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/mattermost.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/resource-sync-by-tgi.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/restrict-nodepool-per-tenant.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/how-to-guides/offboarding/uninstalling.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/installation/aws-eks.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/installation/azure-aks.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/installation/helm.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/installation/kubernetes.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/installation/openshift.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/installation/overview.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/distributing-resources/copying-resources.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/distributing-resources/distributing-manifests.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/tenant/assigning-metadata.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/tenant/create-sandbox.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/tenant/create-tenant.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/tenant/creating-namespaces.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/tenant/deleting-tenant.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
<url>
<loc>https://docs.stakater.com/mto/improve-docs/tutorials/tenant/tenant-hibernation.html</loc>
<lastmod>2025-01-16</lastmod>
<lastmod>2025-01-17</lastmod>
</url>
</urlset>
Binary file modified improve-docs/sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 914672f

Please sign in to comment.