diff --git a/.vale.ini b/.vale.ini index bb8a79f..d4032d7 100644 --- a/.vale.ini +++ b/.vale.ini @@ -8,3 +8,12 @@ Vocab = Stakater [*.md] BasedOnStyles = Vale + +# content/reference/api.md is machine-generated from the operator's Go types +# (via crd-ref-docs). It contains API identifiers and verbatim code comments +# (e.g. the `templates.stakater.com` group, the `LabelSelector` type, the +# `${NAMESPACE}` token), not prose, so prose style rules don't apply. +[content/reference/api.md] +BasedOnStyles = +Vale.Terms = NO +Vale.Spelling = NO diff --git a/content/about/.gitkeep b/content/about/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/content/architecture/.gitkeep b/content/architecture/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/content/architecture/architecture.md b/content/concepts/architecture.md similarity index 100% rename from content/architecture/architecture.md rename to content/concepts/architecture.md diff --git a/content/kubernetes-resources/cluster-template-instance.md b/content/concepts/templates/cluster-template-instance.md similarity index 100% rename from content/kubernetes-resources/cluster-template-instance.md rename to content/concepts/templates/cluster-template-instance.md diff --git a/content/kubernetes-resources/template-instance.md b/content/concepts/templates/template-instance.md similarity index 100% rename from content/kubernetes-resources/template-instance.md rename to content/concepts/templates/template-instance.md diff --git a/content/kubernetes-resources/template.md b/content/concepts/templates/template.md similarity index 100% rename from content/kubernetes-resources/template.md rename to content/concepts/templates/template.md diff --git a/content/architecture/concepts.md b/content/concepts/terminology.md similarity index 100% rename from content/architecture/concepts.md rename to content/concepts/terminology.md diff --git a/content/installation/kubernetes.md b/content/getting-started/installation/kubernetes.md similarity index 100% rename from content/installation/kubernetes.md rename to content/getting-started/installation/kubernetes.md diff --git a/content/installation/openshift.md b/content/getting-started/installation/openshift.md similarity index 88% rename from content/installation/openshift.md rename to content/getting-started/installation/openshift.md index 77d303b..ba03a69 100644 --- a/content/installation/openshift.md +++ b/content/getting-started/installation/openshift.md @@ -18,23 +18,23 @@ This document contains instructions on installing, uninstalling and configuring * After opening OpenShift console click on `Operators`, followed by `OperatorHub` from the side menu - ![OperatorHub](../images/operatorhub.png) + ![OperatorHub](../../images/operatorhub.png) * Now search for `Template Operator` and then click on `Template Operator` tile - ![alt text](../images/template-operator.png) + ![alt text](../../images/template-operator.png) * Click on the `install` button - ![alt text](../images/operator-details.png) + ![alt text](../../images/operator-details.png) * Keep the `Update Channel` and `Version` dropdowns at the latest versions. Select Operator recommended Namespace in `Installed Namespace` section. - ![alt text](../images/install-tab.png) + ![alt text](../../images/install-tab.png) * Wait for the operator to be installed - ![alt text](../images/successful-install.png) + ![alt text](../../images/successful-install.png) > Note: Template Operator will be installed in `template-operator-system` namespace. @@ -84,7 +84,7 @@ This document contains instructions on installing, uninstalling and configuring * After creating the `subscription` custom resource, open OpenShift console and click on `Operators`, followed by `Installed Operators` from the side menu and wait for the installation to complete - ![alt text](../images/wait-for-installation.png) + ![alt text](../../images/wait-for-installation.png) ## Uninstall via OperatorHub UI @@ -92,11 +92,11 @@ You can uninstall Template Operator by following these steps: * After making the required changes open OpenShift console and click on `Operators`, followed by `Installed Operators` from the side menu - ![image](../images/wait-for-installation.png) + ![image](../../images/wait-for-installation.png) * Now click on uninstall and confirm uninstall. - ![alt text](../images/uninstall.png) + ![alt text](../../images/uninstall.png) * Now the operator has been uninstalled. diff --git a/content/installation/overview.md b/content/getting-started/installation/overview.md similarity index 100% rename from content/installation/overview.md rename to content/getting-started/installation/overview.md diff --git a/content/kubernetes-resources/how-to-guides/copying-resources-2.md b/content/guides/templates/copying-resources-2.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/copying-resources-2.md rename to content/guides/templates/copying-resources-2.md diff --git a/content/kubernetes-resources/how-to-guides/copying-resources.md b/content/guides/templates/copying-resources.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/copying-resources.md rename to content/guides/templates/copying-resources.md diff --git a/content/kubernetes-resources/how-to-guides/deploying-private-helm-charts.md b/content/guides/templates/deploying-private-helm-charts.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/deploying-private-helm-charts.md rename to content/guides/templates/deploying-private-helm-charts.md diff --git a/content/kubernetes-resources/how-to-guides/deploying-templates.md b/content/guides/templates/deploying-templates.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/deploying-templates.md rename to content/guides/templates/deploying-templates.md diff --git a/content/kubernetes-resources/how-to-guides/distributing-manifests.md b/content/guides/templates/distributing-manifests.md similarity index 93% rename from content/kubernetes-resources/how-to-guides/distributing-manifests.md rename to content/guides/templates/distributing-manifests.md index 741fc34..a442439 100644 --- a/content/kubernetes-resources/how-to-guides/distributing-manifests.md +++ b/content/guides/templates/distributing-manifests.md @@ -1,6 +1,6 @@ # Distributing Resources in Namespaces -Multi Tenant Operator has two Custom Resources which can cover this need using the [`Template` CR](../template.md), depending upon the conditions and preference. +Multi Tenant Operator has two Custom Resources which can cover this need using the [`Template` CR](../../concepts/templates/template.md), depending upon the conditions and preference. 1. ClusterTemplateInstance 1. TemplateInstance diff --git a/content/kubernetes-resources/how-to-guides/distributing-secrets-using-sealed-secret-template.md b/content/guides/templates/distributing-secrets-using-sealed-secret-template.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/distributing-secrets-using-sealed-secret-template.md rename to content/guides/templates/distributing-secrets-using-sealed-secret-template.md diff --git a/content/kubernetes-resources/how-to-guides/resource-sync-by-tgi.md b/content/guides/templates/resource-sync-by-tgi.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/resource-sync-by-tgi.md rename to content/guides/templates/resource-sync-by-tgi.md diff --git a/content/kubernetes-resources/how-to-guides/template-default-params.md b/content/guides/templates/template-default-params.md similarity index 100% rename from content/kubernetes-resources/how-to-guides/template-default-params.md rename to content/guides/templates/template-default-params.md diff --git a/content/index.md b/content/index.md index efcf9e3..a66a33b 100644 --- a/content/index.md +++ b/content/index.md @@ -22,4 +22,4 @@ Template Operator simplifies cluster administration, enhances security, and enab ## Installation -Refer to the [installation guide](./installation/overview.md) for setting up Template Operator. +Refer to the [installation guide](./getting-started/installation/overview.md) for setting up Template Operator. diff --git a/content/kubernetes-resources/how-to-guides/.gitkeep b/content/kubernetes-resources/how-to-guides/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/content/about/key-features.md b/content/overview/key-features.md similarity index 90% rename from content/about/key-features.md rename to content/overview/key-features.md index 6c96fdf..b162612 100644 --- a/content/about/key-features.md +++ b/content/overview/key-features.md @@ -17,13 +17,13 @@ Common use cases for namespace templates may be: * Deploying pre-populated databases with test data * Injecting new namespaces with optional credentials such as image pull secrets -More details on [Distributing Template Resources](../kubernetes-resources/how-to-guides/deploying-templates.md) +More details on [Distributing Template Resources](../guides/templates/deploying-templates.md) ### Cross Namespace Resource Distribution Template Operator supports cloning of secrets and ConfigMaps from one namespace to another namespace based on label selectors. It uses templates to enable users to provide reference to secrets and ConfigMaps. It uses a Cluster Template Instance to distribute those secrets and namespaces in matching namespaces, while Template Instance copies secret and configMap to a single namespace. -More details on [Copying Secrets and ConfigMaps](../kubernetes-resources/how-to-guides/copying-resources.md) +More details on [Copying Secrets and ConfigMaps](../guides/templates/copying-resources.md) ## Operational Features diff --git a/content/about/benefits.md b/content/overview/use-cases.md similarity index 100% rename from content/about/benefits.md rename to content/overview/use-cases.md diff --git a/content/reference/api.md b/content/reference/api.md new file mode 100644 index 0000000..90d2e33 --- /dev/null +++ b/content/reference/api.md @@ -0,0 +1,432 @@ + +# API Reference + +## Packages +- [templates.stakater.com/v1alpha1](#templatesstakatercomv1alpha1) + + +## templates.stakater.com/v1alpha1 + +Package v1alpha1 contains API Schema definitions for the templates.stakater.com v1alpha1 API group + +### Resource Types +- [ClusterTemplateInstance](#clustertemplateinstance) +- [Template](#template) +- [TemplateInstance](#templateinstance) + + +#### ClusterTemplateInstance + + + +ClusterTemplateInstance is the Schema for the clustertemplateinstances API + + + + + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `apiVersion` _string_ | `templates.stakater.com/v1alpha1` | | | +| `kind` _string_ | `ClusterTemplateInstance` | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `spec` _[ClusterTemplateInstanceSpec](#clustertemplateinstancespec)_ | | | | +| `status` _[ClusterTemplateInstanceStatus](#clustertemplateinstancestatus)_ | | | | + + +#### ClusterTemplateInstanceSpec + + + +ClusterTemplateInstanceSpec defines the desired state of ClusterTemplateInstance + + + +_Appears in:_ +- [ClusterTemplateInstance](#clustertemplateinstance) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `template` _string_ | Template is used to tell what to deploy in matched namespaces | | | +| `selector` _[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#labelselector-v1-meta)_ | Selector is used to filter namespaces where template needs to be deployed | | | +| `sync` _boolean_ | Sync is used to keep deployed instance and template in sync | | | +| `parameters` _[TemplateInstanceParameter](#templateinstanceparameter) array_ | Parameters hold the values of the defined parameters in the template | | Optional: \{\}
| + + +#### TemplateInstanceParameter + + + + + + + +_Appears in:_ +- [ClusterTemplateInstanceSpec](#clustertemplateinstancespec) +- [TemplateInstanceSpec](#templateinstancespec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name is the name of the parameter to set | | | +| `value` _string_ | Value is the value of the parameter to set | | | + + +#### ClusterTemplateInstanceStatus + + + +ClusterTemplateInstanceStatus defines the observed state of ClusterTemplateInstance + + + +_Appears in:_ +- [ClusterTemplateInstance](#clustertemplateinstance) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#condition-v1-meta) array_ | Status conditions | | Optional: \{\}
| +| `deployedNamespaces` _object (keys:string, values:[DeployedNamespaceState](#deployednamespacestate))_ | DeployedNamespaces is a list of namespaces where template has been deployed along with its state. | | Optional: \{\}
| +| `mappedSecrets` _object (keys:string, values:map[string]MappedResourcesState)_ | MappedSecrets is a list of secrets which have been mapped along with its state. | | Optional: \{\}
| +| `mappedConfigmaps` _object (keys:string, values:map[string]MappedResourcesState)_ | MappedConfigmaps is a list of configmaps which have been mapped along with its state. | | Optional: \{\}
| +| `templateManifestsHash` _string_ | TemplateManifestsHash is used to ignore false-positive template.manifests update events | | Optional: \{\}
| +| `templateResourceMappingHash` _string_ | TemplateResourceMappingHash is used to ignore false-positive template.resourceMappings update events | | Optional: \{\}
| +| `namespaceCount` _integer_ | NamespaceCount tells the number of namespaces CTI matches | | Optional: \{\}
| + + +#### Template + + + +Template is the Schema for the templates API + + + + + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `apiVersion` _string_ | `templates.stakater.com/v1alpha1` | | | +| `kind` _string_ | `Template` | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `resources` _[TemplateResources](#templateresources)_ | | | Optional: \{\}
| +| `spec` _[TemplateSpec](#templatespec)_ | | | | +| `status` _[TemplateStatus](#templatestatus)_ | | | Optional: \{\}
| +| `parameters` _[TemplateParameter](#templateparameter) array_ | Parameters can be used to replace certain parts of the template. A parameter is referenced
by this format: $\{NAME\}, to parse the value as an expression write $\{\{NAME\}\} instead. Besides the
parameters defined here, the following predefined parameters can be used:
- $\{NAMESPACE\}: the namespace where the template instance was created
- $\{TENANT\}: the tenant name of the tenant that owns the namespace (if any) | | Optional: \{\}
| + + +#### TemplateResources + + + +TemplateResources defines a templates resources + + + +_Appears in:_ +- [Template](#template) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `manifests` _[EmbeddedResource](#embeddedresource) array_ | manifest represents kubernetes resources that will be deployed into the target namespace | | Optional: \{\}
| +| `helm` _[HelmConfiguration](#helmconfiguration)_ | helm defines the configuration for a helm deployment | | Optional: \{\}
| +| `resourceMappings` _[ResourceMapping](#resourcemapping)_ | ResourceMappings defines the secrets/configmaps which will be mapped into the target namespaces | | Optional: \{\}
| +| `gotemplate` _string_ | gotemplate is a Go template with Sprig functions support which will be rendered to generate Kubernetes resources. | | Optional: \{\}
| + + +#### EmbeddedResource + + + +EmbeddedResource holds a kubernetes resource + + + +_Appears in:_ +- [TemplateResources](#templateresources) + + + +#### HelmConfiguration + + + +HelmConfiguration holds the helm configuration + + + +_Appears in:_ +- [TemplateResources](#templateresources) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `releaseName` _string_ | The helm release name. If omitted the template name will be used | | Optional: \{\}
| +| `setValues` _[HelmSetValue](#helmsetvalue) array_ | Values in the form of name=value that will be passed to the helm command during
helm template | | Optional: \{\}
| +| `values` _string_ | The additional helm values to use. Expected block string | | Optional: \{\}
| +| `chart` _[HelmChart](#helmchart)_ | Tells us where to find the helm chart to deploy | | | + + +#### HelmSetValue + + + +HelmSetValue defines a name=value pair that will be passed to helm template + + + +_Appears in:_ +- [HelmConfiguration](#helmconfiguration) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | The path of the value to set | | | +| `value` _string_ | The value to set | | | +| `forceString` _boolean_ | ForceString specifies if the parameter `--set` or `--set-string` should be used | | Optional: \{\}
| + + +#### HelmChart + + + +HelmChart holds the information needed to find a chart to deploy + + + +_Appears in:_ +- [HelmConfiguration](#helmconfiguration) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `repository` _[HelmChartRepository](#helmchartrepository)_ | Load helm chart from a repository | | Optional: \{\}
| + + +#### HelmChartRepository + + + +HelmChartRepository defines a helm repository where TO can load a chart from + + + +_Appears in:_ +- [HelmChart](#helmchart) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name of the chart to deploy | | | +| `version` _string_ | Version is the version of the chart to deploy | | Optional: \{\}
| +| `repoUrl` _string_ | The repo url to use | | Optional: \{\}
| +| `username` _[HelmSecretRef](#helmsecretref)_ | The username to use for the selected repository | | Optional: \{\}
| +| `password` _[HelmSecretRef](#helmsecretref)_ | The password to use for the selected repository | | Optional: \{\}
| + + +#### HelmSecretRef + + + +HelmSecretRef holds a secret reference to a secret + + + +_Appears in:_ +- [HelmChartRepository](#helmchartrepository) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `key` _string_ | | | | +| `name` _string_ | | | | +| `namespace` _string_ | | | Optional: \{\}
| + + +#### ResourceMapping + + + + + + + +_Appears in:_ +- [TemplateResources](#templateresources) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `secrets` _[Resource](#resource) array_ | Secrets consist of secrets which will be mapped to matching namespaces | | Optional: \{\}
| +| `configMaps` _[Resource](#resource) array_ | ConfigMaps consist of configMaps which will be mapped to matching namespaces | | Optional: \{\}
| + + +#### Resource + + + + + + + +_Appears in:_ +- [ResourceMapping](#resourcemapping) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name is the name of the resource | | Required: \{\}
| +| `namespace` _string_ | Namespace is the namespace where the resource lives | | Required: \{\}
| + + +#### TemplateSpec + + + + + + + +_Appears in:_ +- [Template](#template) + + + +#### TemplateStatus + + + + + + + +_Appears in:_ +- [Template](#template) + + + +#### TemplateParameter + + + + + + + +_Appears in:_ +- [Template](#template) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name is the name of the parameter | | | +| `value` _string_ | Value is the default value of the parameter | | Optional: \{\}
| +| `required` _boolean_ | If required is true, the template instance must
define this parameter, otherwise the deployment will fail. | | Optional: \{\}
| +| `validation` _string_ | Validation takes a regular expression as value to
verify the provided value does match expected values. | | Optional: \{\}
| + + +#### TemplateInstance + + + +TemplateInstance is the Schema for the templatesinstance API + + + + + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `apiVersion` _string_ | `templates.stakater.com/v1alpha1` | | | +| `kind` _string_ | `TemplateInstance` | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `spec` _[TemplateInstanceSpec](#templateinstancespec)_ | | | | +| `status` _[TemplateInstanceStatus](#templateinstancestatus)_ | | | Optional: \{\}
| + + +#### TemplateInstanceSpec + + + +TemplateInstanceSpec holds the expected cluster status of the template instance + + + +_Appears in:_ +- [TemplateInstance](#templateinstance) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `template` _string_ | The template to instantiate. This is an immutable field | | | +| `sync` _boolean_ | If true the template instance will keep the deployed resources in sync with the template. | | Optional: \{\}
| +| `parameters` _[TemplateInstanceParameter](#templateinstanceparameter) array_ | Parameters hold the values of the defined parameters in the template | | Optional: \{\}
| + + +#### TemplateInstanceStatus + + + +TemplateInstanceStatus describes the current status of the template instance in the cluster + + + +_Appears in:_ +- [TemplateInstance](#templateinstance) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `status` _[InstanceDeploymentStatus](#instancedeploymentstatus)_ | Status holds the template instances status | | | +| `message` _string_ | A human readable message indicating details about why the namespace is in this condition. | | Optional: \{\}
| +| `reason` _string_ | A brief CamelCase message indicating details about why the namespace is in this state. | | Optional: \{\}
| +| `templateHash` _string_ | TemplateHash is used to ignore false-positive template update events | | Optional: \{\}
| +| `templateManifests` _string_ | TemplateManifests are the manifests that were rendered before | | Optional: \{\}
| +| `mappedSecrets` _object (keys:string, values:[MappedResourcesState](#mappedresourcesstate))_ | MappedSecrets is a list of secrets which have been mapped along with its state. | | Optional: \{\}
| +| `mappedConfigmaps` _object (keys:string, values:[MappedResourcesState](#mappedresourcesstate))_ | MappedConfigmaps is a list of configmaps which have been mapped along with its state. | | Optional: \{\}
| +| `observedAt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#time-v1-meta)_ | LastAppliedAt indicates when the template was last applied | | Optional: \{\}
| + + +#### InstanceDeploymentStatus + +_Underlying type:_ _string_ + +InstanceDeploymentStatus describes the status of template instance deployment as {"Deployed", "Failed", ""} + + + +_Appears in:_ +- [DeployedNamespaceState](#deployednamespacestate) +- [MappedResourcesState](#mappedresourcesstate) +- [TemplateInstanceStatus](#templateinstancestatus) + +| Field | Description | +| --- | --- | +| `Deployed` | InstanceDeploymentStatusDeployed describes a succeeded instance deployment
| +| `Failed` | InstanceDeploymentStatusFailed describes a failed instance deployment
| +| `` | InstanceDeploymentStatusPending describes a not yet deployed instance
| + + +#### DeployedNamespaceState + + + + + + + +_Appears in:_ +- [ClusterTemplateInstanceStatus](#clustertemplateinstancestatus) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `templateManifests` _string_ | TemplateManifests are the manifests that were rendered before | | Optional: \{\}
| +| `status` _[InstanceDeploymentStatus](#instancedeploymentstatus)_ | | | | + + +#### MappedResourcesState + + + + + + + +_Appears in:_ +- [ClusterTemplateInstanceStatus](#clustertemplateinstancestatus) +- [TemplateInstanceStatus](#templateinstancestatus) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `reason` _string_ | Reason of resource mapping if failed | | Optional: \{\}
| +| `status` _[InstanceDeploymentStatus](#instancedeploymentstatus)_ | | | | + diff --git a/content/architecture/logs-metrics.md b/content/reference/metrics.md similarity index 100% rename from content/architecture/logs-metrics.md rename to content/reference/metrics.md diff --git a/content/changelog.md b/content/release-notes.md similarity index 100% rename from content/changelog.md rename to content/release-notes.md diff --git a/theme_override/mkdocs.yml b/theme_override/mkdocs.yml index 417dcb7..1e2049c 100644 --- a/theme_override/mkdocs.yml +++ b/theme_override/mkdocs.yml @@ -17,32 +17,35 @@ extra: default: latest nav: - - index.md - - About: - - about/key-features.md - - about/benefits.md - - Architecture: - - architecture/architecture.md - - architecture/logs-metrics.md - - Installation: - - installation/overview.md - - installation/openshift.md - - installation/kubernetes.md - - Kubernetes Resources: - - architecture/concepts.md - - kubernetes-resources/template.md - - kubernetes-resources/template-instance.md - - kubernetes-resources/cluster-template-instance.md - - How-to Guides: - - Template: - - kubernetes-resources/how-to-guides/copying-resources.md - - kubernetes-resources/how-to-guides/copying-resources-2.md - - kubernetes-resources/how-to-guides/distributing-manifests.md - - kubernetes-resources/how-to-guides/deploying-templates.md - - kubernetes-resources/how-to-guides/resource-sync-by-tgi.md - - kubernetes-resources/how-to-guides/distributing-secrets-using-sealed-secret-template.md - - kubernetes-resources/how-to-guides/deploying-private-helm-charts.md - - kubernetes-resources/how-to-guides/template-default-params.md - - changelog.md - - eula.md - - troubleshooting.md \ No newline at end of file + - Overview: + - index.md + - overview/key-features.md + - overview/use-cases.md + - Concepts: + - concepts/architecture.md + - concepts/terminology.md + - Templates: + - concepts/templates/template.md + - concepts/templates/template-instance.md + - concepts/templates/cluster-template-instance.md + - Getting Started: + - Installation: + - getting-started/installation/overview.md + - getting-started/installation/openshift.md + - getting-started/installation/kubernetes.md + - Guides: + - Templates: + - guides/templates/deploying-templates.md + - guides/templates/distributing-manifests.md + - guides/templates/copying-resources.md + - guides/templates/copying-resources-2.md + - guides/templates/distributing-secrets-using-sealed-secret-template.md + - guides/templates/deploying-private-helm-charts.md + - guides/templates/template-default-params.md + - guides/templates/resource-sync-by-tgi.md + - Reference: + - reference/api.md + - reference/metrics.md + - Troubleshooting: troubleshooting.md + - Release Notes: release-notes.md + - EULA: eula.md \ No newline at end of file