updated site

jenkins-x · Sep 10, 2024 · 8563bab · 8563bab
1 parent 8130eae
commit 8563bab
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 29 deletions.
diff --git a/v3/admin/platforms/eks/index.html b/v3/admin/platforms/eks/index.html
@@ -1490,16 +1490,10 @@ <h1>Amazon</h1>
 <ul>
 <li>Ensure you are logged into GitHub else you will get a 404 error when clicking the links below</li>
 <li>The quickstart guides are for users who want to get up and running quickly with Jenkins X.
-Refer to the <a href="https://github.com/jenkins-x/terraform-aws-eks-jx/blob/master/README.md">eks-jx terraform module readme</a> for all the variables that can be customized.
-<ul>
-<li>Refer to this <a href="/v3/admin/setup/secrets/vault/#external-vault">page</a> for setting up Jenkins X v3 with external/existing vault.</li>
-<li>For installing Jenkins X in an existing EKS cluster, refer to this <a href="https://github.com/jenkins-x/terraform-aws-eks-jx#existing-eks-cluster">section</a>.</li>
-<li>To use AWS secrets manager instead of vault, refer to this <a href="https://github.com/jenkins-x/terraform-aws-eks-jx#secrets-management">section</a></li>
-</ul>
-</li>
+Refer to the <a href="https://github.com/jenkins-x/terraform-aws-eks-jx/blob/master/README.md">eks-jx terraform module readme</a> for all the inputs that can be customized.</li>
 <li>Always use the latest module version for the eks-jx module.
 The list of versions can be found <a href="https://github.com/jenkins-x/terraform-aws-eks-jx/releases">here.</a></li>
-<li>Do not specify the last digit of the kubernetes version, so if you want to provision an EKS cluster with kubernetes <code>1.21.5</code>, just specify <code>1.21</code>. See <a href="https://github.com/jx3-gitops-repositories/jx3-terraform-eks/issues/26#issuecomment-936055015">this issue</a> for more details.</li>
+<li>Do not specify the last digit of the kubernetes version, so if you want to provision an EKS cluster with kubernetes <code>1.30.1</code>, just specify <code>1.30</code>.</li>
 </ul>
 <hr>
 <h3 id="eks--terraform--vaultasm--github">EKS + Terraform + Vault/ASM + Github</h3>
@@ -1536,13 +1530,14 @@ <h3 id="eks--terraform--vaultasm--github">EKS + Terraform + Vault/ASM + Github</
 <p>You should use a dedicated git user account for the Bot user. Jenkins X will use this user to interact with git. After you are logged in with the Bot user account you may use the following link <a href="https://github.com/settings/tokens/new?scopes=repo,read:user,read:org,user:email,admin:repo_hook,write:packages,read:packages,write:discussion,workflow" target="github-token" class="btn bg-primary text-light">Create Git Token for the Bot user </a></p>
 </li>
 <li>
-<p>Override the variable defaults in the Infrastructure repository. (E.g, edit variables.tf, set TF<em>VAR</em> environment variables, or pass the values on the terraform command line.)</p>
+<p>Override the input defaults in the Infrastructure repository. (E.g, edit variables.tf, set TF<em>VAR</em> environment variables, or pass the values on the terraform command line.)</p>
 <ul>
-<li>cluster_version: Kubernetes version for the EKS cluster. (should be 1.20 at the moment)</li>
-<li>region: AWS region code for the AWS region to create the cluster in.</li>
-<li>jx_git_url: URL of the Cluster repository.</li>
-<li>jx_bot_username: The username of the git bot user</li>
+<li><code>cluster_version</code>: Kubernetes version for the EKS cluster. (should be 1.20 at the moment)</li>
+<li><code>region</code>: AWS region code for the AWS region to create the cluster in.</li>
+<li><code>jx_git_url</code>: URL of the Cluster repository.</li>
+<li><code>jx_bot_username</code>: The username of the git bot user</li>
 </ul>
+<p>If you want to use AWS secrets manager instead of vault you should also set the following inputs <code>use_asm</code> to true.</p>
 </li>
 <li>
 <p>commit and push any changes to your Infrastructure git repository:</p>
@@ -1563,7 +1558,7 @@ <h3 id="eks--terraform--vaultasm--github">EKS + Terraform + Vault/ASM + Github</
 </span></span></code></pre></div><ul>
 <li>Tail the Jenkins X installation logs</li>
 </ul>
-<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>  <span style="color:#66d9ef">$(</span>terraform output follow_install_logs<span style="color:#66d9ef">)</span>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>  jx admin log
 </span></span></code></pre></div><ul>
 <li>Once finished you can now move into the Jenkins X Developer namespace</li>
 </ul>
@@ -1653,7 +1648,7 @@ <h2 class="feedback--title">Feedback</h2>
 
 
 	<div class="text-muted mt-5 pt-3 border-top">
-  Last modified October 14, 2022: <a href="https://github.com/jenkins-x/jx-docs/commit/6816807ca12af198ec36d7d7bcb8976675621b05">fix: add shortcode displaying compatible k8s versions supported by Jenkins X (6816807ca1)</a>
+  Last modified August 1, 2024: <a href="https://github.com/jenkins-x/jx-docs/commit/af866e23312f6cdd5b43fa9459c562a1fdad1f3d">docs: update after refactored eks terraform modules (af866e2331)</a>
 </div>
 
 </div>

diff --git a/v3/admin/platforms/index.xml b/v3/admin/platforms/index.xml
@@ -32,16 +32,10 @@
 &lt;ul&gt;
 &lt;li&gt;Ensure you are logged into GitHub else you will get a 404 error when clicking the links below&lt;/li&gt;
 &lt;li&gt;The quickstart guides are for users who want to get up and running quickly with Jenkins X.
-Refer to the &lt;a href=&#34;https://github.com/jenkins-x/terraform-aws-eks-jx/blob/master/README.md&#34;&gt;eks-jx terraform module readme&lt;/a&gt; for all the variables that can be customized.
-&lt;ul&gt;
-&lt;li&gt;Refer to this &lt;a href=&#34;https://jenkins-x.io/v3/admin/setup/secrets/vault/#external-vault&#34;&gt;page&lt;/a&gt; for setting up Jenkins X v3 with external/existing vault.&lt;/li&gt;
-&lt;li&gt;For installing Jenkins X in an existing EKS cluster, refer to this &lt;a href=&#34;https://github.com/jenkins-x/terraform-aws-eks-jx#existing-eks-cluster&#34;&gt;section&lt;/a&gt;.&lt;/li&gt;
-&lt;li&gt;To use AWS secrets manager instead of vault, refer to this &lt;a href=&#34;https://github.com/jenkins-x/terraform-aws-eks-jx#secrets-management&#34;&gt;section&lt;/a&gt;&lt;/li&gt;
-&lt;/ul&gt;
-&lt;/li&gt;
+Refer to the &lt;a href=&#34;https://github.com/jenkins-x/terraform-aws-eks-jx/blob/master/README.md&#34;&gt;eks-jx terraform module readme&lt;/a&gt; for all the inputs that can be customized.&lt;/li&gt;
 &lt;li&gt;Always use the latest module version for the eks-jx module.
 The list of versions can be found &lt;a href=&#34;https://github.com/jenkins-x/terraform-aws-eks-jx/releases&#34;&gt;here.&lt;/a&gt;&lt;/li&gt;
-&lt;li&gt;Do not specify the last digit of the kubernetes version, so if you want to provision an EKS cluster with kubernetes &lt;code&gt;1.21.5&lt;/code&gt;, just specify &lt;code&gt;1.21&lt;/code&gt;. See &lt;a href=&#34;https://github.com/jx3-gitops-repositories/jx3-terraform-eks/issues/26#issuecomment-936055015&#34;&gt;this issue&lt;/a&gt; for more details.&lt;/li&gt;
+&lt;li&gt;Do not specify the last digit of the kubernetes version, so if you want to provision an EKS cluster with kubernetes &lt;code&gt;1.30.1&lt;/code&gt;, just specify &lt;code&gt;1.30&lt;/code&gt;.&lt;/li&gt;
 &lt;/ul&gt;
 &lt;hr&gt;
 &lt;h3 id=&#34;eks--terraform--vaultasm--github&#34;&gt;EKS + Terraform + Vault/ASM + Github&lt;/h3&gt;
@@ -78,13 +72,14 @@ The list of versions can be found &lt;a href=&#34;https://github.com/jenkins-x/t
 &lt;p&gt;You should use a dedicated git user account for the Bot user. Jenkins X will use this user to interact with git. After you are logged in with the Bot user account you may use the following link &lt;a href=&#34;https://github.com/settings/tokens/new?scopes=repo,read:user,read:org,user:email,admin:repo_hook,write:packages,read:packages,write:discussion,workflow&#34; target=&#34;github-token&#34; class=&#34;btn bg-primary text-light&#34;&gt;Create Git Token for the Bot user &lt;/a&gt;&lt;/p&gt;
 &lt;/li&gt;
 &lt;li&gt;
-&lt;p&gt;Override the variable defaults in the Infrastructure repository. (E.g, edit variables.tf, set TF&lt;em&gt;VAR&lt;/em&gt; environment variables, or pass the values on the terraform command line.)&lt;/p&gt;
+&lt;p&gt;Override the input defaults in the Infrastructure repository. (E.g, edit variables.tf, set TF&lt;em&gt;VAR&lt;/em&gt; environment variables, or pass the values on the terraform command line.)&lt;/p&gt;
 &lt;ul&gt;
-&lt;li&gt;cluster_version: Kubernetes version for the EKS cluster. (should be 1.20 at the moment)&lt;/li&gt;
-&lt;li&gt;region: AWS region code for the AWS region to create the cluster in.&lt;/li&gt;
-&lt;li&gt;jx_git_url: URL of the Cluster repository.&lt;/li&gt;
-&lt;li&gt;jx_bot_username: The username of the git bot user&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;cluster_version&lt;/code&gt;: Kubernetes version for the EKS cluster. (should be 1.20 at the moment)&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;region&lt;/code&gt;: AWS region code for the AWS region to create the cluster in.&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;jx_git_url&lt;/code&gt;: URL of the Cluster repository.&lt;/li&gt;
+&lt;li&gt;&lt;code&gt;jx_bot_username&lt;/code&gt;: The username of the git bot user&lt;/li&gt;
 &lt;/ul&gt;
+&lt;p&gt;If you want to use AWS secrets manager instead of vault you should also set the following inputs &lt;code&gt;use_asm&lt;/code&gt; to true.&lt;/p&gt;
 &lt;/li&gt;
 &lt;li&gt;
 &lt;p&gt;commit and push any changes to your Infrastructure git repository:&lt;/p&gt;
@@ -105,7 +100,7 @@ The list of versions can be found &lt;a href=&#34;https://github.com/jenkins-x/t
 &lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;ul&gt;
 &lt;li&gt;Tail the Jenkins X installation logs&lt;/li&gt;
 &lt;/ul&gt;
-&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;  &lt;span style=&#34;color:#66d9ef&#34;&gt;$(&lt;/span&gt;terraform output follow_install_logs&lt;span style=&#34;color:#66d9ef&#34;&gt;)&lt;/span&gt;
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-bash&#34; data-lang=&#34;bash&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;  jx admin log
 &lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;ul&gt;
 &lt;li&gt;Once finished you can now move into the Jenkins X Developer namespace&lt;/li&gt;
 &lt;/ul&gt;