Skip to content

Commit

Permalink
ci: publish documentation for 1027c34
Browse files Browse the repository at this point in the history
  • Loading branch information
@lentidas
lentidas committed Sep 15, 2023
1 parent 3c95fb9 commit 1ed76c8
Show file tree
Hide file tree
Showing 536 changed files with 13,583 additions and 1,145 deletions.
158 changes: 113 additions & 45 deletions docs/application/latest/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="application" data-version="v2.0.1">
<div class="nav-container" data-component="application" data-version="v2.1.0">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
Expand All @@ -62,14 +62,17 @@ <h3 class="title"><a href="README.html">Application Module</a></h3>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Application Module</span>
<span class="version">v2.0.1</span>
<span class="version">v2.1.0</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="README.html">Application Module</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="README.html">v2.0.1</a>
<a href="README.html">v2.1.0</a>
</li>
<li class="version">
<a href="../v2.0.1/README.html">v2.0.1</a>
</li>
<li class="version">
<a href="../v2.0.0/README.html">v2.0.0</a>
Expand Down Expand Up @@ -101,7 +104,10 @@ <h3 class="title"><a href="README.html">Application Module</a></h3>
<a class="title" href="../../applicationset/latest/README.html">ApplicationSet Module</a>
<ul class="versions">
<li class="version is-latest">
<a href="../../applicationset/latest/README.html">v2.0.1</a>
<a href="../../applicationset/latest/README.html">v2.1.0</a>
</li>
<li class="version">
<a href="../../applicationset/v2.0.1/README.html">v2.0.1</a>
</li>
<li class="version">
<a href="../../applicationset/v2.0.0/README.html">v2.0.0</a>
Expand Down Expand Up @@ -603,6 +609,14 @@ <h3 class="title"><a href="README.html">Application Module</a></h3>
</li>
</ul>
</li>
<li class="component">
<a class="title" href="../../velero/latest/README.html">Velero Module</a>
<ul class="versions">
<li class="version is-latest">
<a href="../../velero/latest/README.html">v1.0.0</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
Expand All @@ -618,9 +632,10 @@ <h3 class="title"><a href="README.html">Application Module</a></h3>
</ul>
</nav>
<div class="page-versions">
<button class="version-menu-toggle" title="Show other versions of page">v2.0.1</button>
<button class="version-menu-toggle" title="Show other versions of page">v2.1.0</button>
<div class="version-menu">
<a class="version is-current" href="README.html">v2.0.1</a>
<a class="version is-current" href="README.html">v2.1.0</a>
<a class="version" href="../v2.0.1/README.html">v2.0.1</a>
<a class="version" href="../v2.0.0/README.html">v2.0.0</a>
<a class="version" href="../v1.2.3/README.html">v1.2.3</a>
<a class="version" href="../v1.2.2/README.html">v1.2.2</a>
Expand All @@ -631,7 +646,7 @@ <h3 class="title"><a href="README.html">Application Module</a></h3>
<a class="version" href="../v1.0.1/README.html">v1.0.1</a>
</div>
</div>
<div class="edit-this-page"><a href="https://github.com/camptocamp/devops-stack-module-application/blob/v2.0.1/docs/modules/ROOT/pages/README.adoc">Edit this Page</a></div>
<div class="edit-this-page"><a href="https://github.com/camptocamp/devops-stack-module-application/blob/v2.1.0/docs/modules/ROOT/pages/README.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
Expand Down Expand Up @@ -683,13 +698,15 @@ <h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
source = "git::https://github.com/camptocamp/devops-stack-module-application.git?ref=&lt;RELEASE&gt;"

name = "application-name"
argocd_namespace = local.argocd_namespace
argocd_namespace = module.argocd_bootstrap.argocd_namespace

source_repo = "https://address.com/owner/repository.git"
source_repo_path = "path/to/chart"
source_target_revision = "branch"

depends_on = [module.argocd]
dependency_ids = {
argocd = module.argocd.id
}
}</code></pre>
</div>
</div>
Expand All @@ -702,7 +719,7 @@ <h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
source = "git::https://github.com/camptocamp/devops-stack-module-application.git?ref=&lt;RELEASE&gt;"

name = "application-name"
argocd_namespace = local.argocd_namespace
argocd_namespace = module.argocd_bootstrap.argocd_namespace

source_repo = "https://address.com/owner/repository.git"
source_repo_path = "path/to/chart"
Expand All @@ -728,7 +745,9 @@ <h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
},
]

depends_on = [module.argocd]
dependency_ids = {
argocd = module.argocd.id
}
}</code></pre>
</div>
</div>
Expand All @@ -741,7 +760,7 @@ <h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
source = "git::https://github.com/camptocamp/devops-stack-module-application.git?ref=&lt;RELEASE&gt;"

name = "application-name"
argocd_namespace = local.argocd_namespace
argocd_namespace = module.argocd_bootstrap.argocd_namespace

source_repo = "https://address.com/owner/repository.git"
source_repo_path = "path/to/chart"
Expand All @@ -768,7 +787,9 @@ <h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
]
}]

depends_on = [module.argocd]
dependency_ids = {
argocd = module.argocd.id
}
}</code></pre>
</div>
</div>
Expand All @@ -792,7 +813,7 @@ <h4 id="_ssh"><a class="anchor" href="#_ssh"></a>SSH</h4>
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
Do not hardcode your SSH private key as the example below! Either create the SSH key using Terraform and pass the output directly or use SOPS to store and pass the key as a secret.
Do not hardcode your SSH private key like in the example below! Either create the SSH key using Terraform and pass the output directly or use SOPS to store and pass the key as a secret.
</td>
</tr>
</table>
Expand All @@ -803,15 +824,17 @@ <h4 id="_ssh"><a class="anchor" href="#_ssh"></a>SSH</h4>
source = "git::https://github.com/camptocamp/devops-stack-module-application.git?ref=&lt;RELEASE&gt;"

name = "application-name"
argocd_namespace = local.argocd_namespace
argocd_namespace = module.argocd_bootstrap.argocd_namespace

source_repo = "[email protected]:owner/repository"
source_repo_path = "path/to/chart"
source_target_revision = "branch"

source_credentials_ssh_key = "-----BEGIN OPENSSH PRIVATE KEY-----\nfoo\nbar\n-----END OPENSSH PRIVATE KEY-----"

depends_on = [module.argocd]
dependency_ids = {
argocd = module.argocd.id
}
}</code></pre>
</div>
</div>
Expand All @@ -828,7 +851,7 @@ <h4 id="_https"><a class="anchor" href="#_https"></a>HTTPS</h4>
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
Do not hardcode your password the example below! It is recommended to pass the value as secret, either using SOPS or another provider. Another best practice would be to use a token you created on Github.com (or another provider) that has the least amount of access needed (in these use-case, Argo CD only needs read access).
Do not hardcode your password like in the example below! It is recommended to pass the value as secret, either using SOPS or another provider. Another best practice would be to use a token you created on Github.com (or another provider) that has the least amount of access needed (in this use-case, Argo CD only needs read access).
</td>
</tr>
</table>
Expand All @@ -839,7 +862,7 @@ <h4 id="_https"><a class="anchor" href="#_https"></a>HTTPS</h4>
source = "git::https://github.com/camptocamp/devops-stack-module-application.git?ref=&lt;RELEASE&gt;"

name = "application-name"
argocd_namespace = local.argocd_namespace
argocd_namespace = module.argocd_bootstrap.argocd_namespace

source_repo = "https://address.com/owner/repository.git"
source_repo_path = "path/to/chart"
Expand All @@ -851,7 +874,9 @@ <h4 id="_https"><a class="anchor" href="#_https"></a>HTTPS</h4>
https_insecure = false
}

depends_on = [module.argocd]
dependency_ids = {
argocd = module.argocd.id
}
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -898,13 +923,13 @@ <h3 id="_providers"><a class="anchor" href="#_providers"></a>Providers</h3>
<div class="ulist">
<ul>
<li>
<p><a id="provider_null"></a> <a href="#provider_null">null</a> (&gt;= 3)</p>
<p><a id="provider_utils"></a> <a href="#provider_utils">utils</a> (&gt;= 1)</p>
</li>
<li>
<p><a id="provider_argocd"></a> <a href="#provider_argocd">argocd</a> (&gt;= 5)</p>
</li>
<li>
<p><a id="provider_utils"></a> <a href="#provider_utils">utils</a> (&gt;= 1)</p>
<p><a id="provider_null"></a> <a href="#provider_null">null</a> (&gt;= 3)</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -1054,6 +1079,30 @@ <h4 id="_dependency_ids"><a class="anchor" href="#_dependency_ids"></a><a id="in
</div>
</div>
<div class="sect3">
<h4 id="_project_dest_cluster_name"><a class="anchor" href="#_project_dest_cluster_name"></a><a id="input_project_dest_cluster_name"></a> <a href="#input_project_dest_cluster_name">project_dest_cluster_name</a></h4>
<div class="paragraph">
<p>Description: Allowed destination cluster <strong>name</strong> in the AppProject.</p>
</div>
<div class="paragraph">
<p>Type: <code>string</code></p>
</div>
<div class="paragraph">
<p>Default: <code>"in-cluster"</code></p>
</div>
</div>
<div class="sect3">
<h4 id="_project_dest_cluster_address"><a class="anchor" href="#_project_dest_cluster_address"></a><a id="input_project_dest_cluster_address"></a> <a href="#input_project_dest_cluster_address">project_dest_cluster_address</a></h4>
<div class="paragraph">
<p>Description: Allowed destination cluster <strong>address</strong> in the AppProject. If you define this variable, any value passed in the <code>project_dest_cluster_name</code> variable is ignored.</p>
</div>
<div class="paragraph">
<p>Type: <code>string</code></p>
</div>
<div class="paragraph">
<p>Default: <code>null</code></p>
</div>
</div>
<div class="sect3">
<h4 id="_destination_namespace"><a class="anchor" href="#_destination_namespace"></a><a id="input_destination_namespace"></a> <a href="#input_destination_namespace">destination_namespace</a></h4>
<div class="paragraph">
<p>Description: Namespace where the application will be deployed. By default it is the same as the application&#8217;s name defined by <code>var.name</code>. We use a ternary operator to conditionally define the Namespace only if it is defined on the module&#8217;s instantiation: <code>namespace = var.destination_namespace == null ? var.name : var.destination_namespace</code>.</p>
Expand Down Expand Up @@ -1138,21 +1187,12 @@ <h4 id="_source_credentials_https"><a class="anchor" href="#_source_credentials_
<pre class="highlightjs highlight"><code class="language-hcl hljs" data-lang="hcl">object({
username = string
password = string
https_insecure = bool
https_insecure = optional(bool, false)
})</code></pre>
</div>
</div>
<div class="paragraph">
<p>Default:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
"https_insecure": false,
"password": null,
"username": null
}</code></pre>
</div>
<p>Default: <code>null</code></p>
</div>
</div>
<div class="sect3">
Expand Down Expand Up @@ -1243,10 +1283,10 @@ <h3 id="_reference_in_table_format"><a class="anchor" href="#_reference_in_table
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a id="provider_utils"></a> <a href="#provider_utils">utils</a></p>
<p><a id="provider_null"></a> <a href="#provider_null">null</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>&gt;= 1</p>
<p>&gt;= 3</p>
</div></div></td>
</tr>
<tr>
Expand All @@ -1259,10 +1299,10 @@ <h3 id="_reference_in_table_format"><a class="anchor" href="#_reference_in_table
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a id="provider_null"></a> <a href="#provider_null">null</a></p>
<p><a id="provider_utils"></a> <a href="#provider_utils">utils</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>&gt;= 3</p>
<p>&gt;= 1</p>
</div></div></td>
</tr>
</tbody>
Expand Down Expand Up @@ -1511,6 +1551,40 @@ <h3 id="_reference_in_table_format"><a class="anchor" href="#_reference_in_table
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a id="input_project_dest_cluster_name"></a> <a href="#input_project_dest_cluster_name">project_dest_cluster_name</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Allowed destination cluster <strong>name</strong> in the AppProject.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>string</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>"in-cluster"</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>no</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a id="input_project_dest_cluster_address"></a> <a href="#input_project_dest_cluster_address">project_dest_cluster_address</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Allowed destination cluster <strong>address</strong> in the AppProject. If you define this variable, any value passed in the <code>project_dest_cluster_name</code> variable is ignored.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>string</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>null</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>no</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a id="input_destination_namespace"></a> <a href="#input_destination_namespace">destination_namespace</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
Expand Down Expand Up @@ -1596,18 +1670,12 @@ <h3 id="_reference_in_table_format"><a class="anchor" href="#_reference_in_table
<pre class="highlightjs highlight"><code class="language-none hljs">object({
username = string
password = string
https_insecure = bool
https_insecure = optional(bool, false)
})</code></pre>
</div>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-none hljs">{
"https_insecure": false,
"password": null,
"username": null
}</code></pre>
</div>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>null</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>no</p>
Expand Down
Loading

0 comments on commit 1ed76c8

Please sign in to comment.