/docs/setup/install/prepare/ Recent content in Prepare to Install Verrazzano on Verrazzano Enterprise Container Platform Hugo -- gohugo.io /docs/setup/install/prepare/prereqs/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/setup/install/prepare/prereqs/ <p>Verrazzano requires the following:</p> <ul> <li> <p>A Kubernetes cluster and a compatible <code>kubectl</code>.</p> </li> <li> <p><a href="../../../../docs/networking/#high-level-network-diagram">Two load balancers</a>. Note that in a Verrazzano multicluster environment, two load balancers are required for each cluster.</p> </li> <li> <p><code>dev</code> profile - Each node in the cluster should contain at least two CPUs, 16 GB RAM, and 100 GB of disk storage. The entire cluster requires at least six CPUs, 48 GB RAM, and 100 GB of disk storage. In addition, about 52 GB of storage is required for the persistent volumes.</p> </li> <li> <p><code>prod</code> profile - Each node in the cluster should contain at least four CPUs, 32 GB RAM, and 100 GB of disk storage. The entire cluster requires at least eight CPUs, 64 GB RAM, and 150 GB of disk storage. In addition, about 450 GB of storage is required for the persistent volumes.</p> <p>The <code>storageClassName</code> is not available for all the components where you configure persistent volumes, therefore, when it is not specified, the default <a href="https://kubernetes.io/docs/tasks/administer-cluster/change-default-storage-class/">StorageClass</a> from the cluster is used.</p> </li> </ul> <div class="alert alert-primary" role="alert"> <h4 class="alert-heading">NOTE</h4> To avoid conflicts with Verrazzano system components, we recommend installing Verrazzano into an empty cluster. Also, depending on the resource requirements of the applications you deploy, the configurations previously suggested may or may not be sufficient. </div> <h2 id="supported-hardware">Supported hardware</h2> <p>Verrazzano requires x86-64; other architectures are not supported.</p> <h2 id="supported-software-versions">Supported software versions</h2> <p>Verrazzano supports the following software versions.</p> <h3 id="kubernetes">Kubernetes</h3> <p>You can install Verrazzano on the following Kubernetes versions.</p> <table> <thead> <tr> <th>Verrazzano</th> <th>Kubernetes Versions</th> </tr> </thead> <tbody> <tr> <td>1.6</td> <td>1.24, 1.25, 1.26</td> </tr> <tr> <td>1.5</td> <td>1.21, 1.22, 1.23, 1.24</td> </tr> <tr> <td>1.4</td> <td>1.21, 1.22, 1.23, 1.24</td> </tr> <tr> <td>1.3</td> <td>1.21, 1.22, 1.23</td> </tr> <tr> <td>1.2</td> <td>1.19, 1.20, 1.21</td> </tr> <tr> <td>1.1</td> <td>1.19, 1.20, 1.21</td> </tr> <tr> <td>1.0</td> <td>1.18, 1.19, 1.20</td> </tr> </tbody> </table> <br> <p>For more information, see <a href="https://kubernetes.io/releases/">Kubernetes Release Documentation</a>. <br>For platform specific details, see <a href="../../../../docs/setup/install/prepare/platforms/">Verrazzano platform setup</a>.</p> <h3 id="weblogic-server">WebLogic Server</h3> <p>The supported versions of WebLogic Server are dependent on the <a href="https://oracle.github.io/weblogic-kubernetes-operator/">WebLogic Kubernetes Operator</a> version. See the WebLogic Server versions supported <a href="https://oracle.github.io/weblogic-kubernetes-operator/introduction/prerequisites/introduction/">here</a>.</p> <h3 id="coherence">Coherence</h3> <p>The supported versions of Coherence are dependent on the <a href="https://oracle.github.io/coherence-operator/docs/latest/#/about/01_overview">Coherence Operator</a> version. See the Coherence versions supported <a href="https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/01_installation">here</a>.</p> <h3 id="helidon">Helidon</h3> <p>Verrazzano supports all versions of Helidon. For more information, see <a href="https://helidon.io">Helidon</a> and <a href="https://support.oracle.com/knowledge/Middleware/2645279_1.html">Helidon Commercial Offerings</a>.</p> <h3 id="verrazzano-installed-software">Verrazzano installed software</h3> <p>For a detailed list of Verrazzano installed software, see <a href="../../../../docs/setup/install/verify/softwares/">here</a>.</p> /docs/setup/install/prepare/cli-setup/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/setup/install/prepare/cli-setup/ <p>The Verrazzano command-line tool, <code>vz</code>, is available for Linux and Mac systems. Download the binary you want from the <a href="https://github.com/verrazzano/verrazzano/releases/">Releases</a> page.</p> <div class="alert alert-primary" role="alert"> <h4 class="alert-heading">NOTE</h4> <ul> <li>Installing the command-line tool, <code>vz</code>, is optional.</li> <li>For optimal functionality, install or upgrade the CLI version to match the desired Verrazzano version.</li> </ul> </div> <h2 id="install-the-vz-cli">Install the vz CLI</h2> <p>These instructions demonstrate installing the CLI on Linux AMD64 machines.</p> <h3 id="download-the-latest-release">Download the latest release</h3> <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre><code> $ curl -LO https://github.com/verrazzano/verrazzano/releases/download/master/verrazzano-1.6.0-linux-amd64.tar.gz </code></pre> </div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script> <h3 id="validate-the-binary-optional">Validate the binary (optional)</h3> <p>Download the <code>vz</code> checksum file. <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre><code> $ curl -LO https://github.com/verrazzano/verrazzano/releases/download/master/verrazzano-1.6.0-linux-amd64.tar.gz.sha256 </code></pre> </div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <p>Validate the <code>vz</code> binary against the checksum file. <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre><code>$ sha256sum -c verrazzano-2.0.0-linux-amd64.tar.gz.sha256 </code></pre> </div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <h3 id="unpack-and-copy-the-vz-binary">Unpack and copy the vz binary</h3> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span> $ tar xvf verrazzano-2.0.0-linux-amd64.tar.gz </span></span></code></pre></div><p>The following command needs to be run as root.</p> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span> $ sudo cp verrazzano-2.0.0/bin/vz /usr/local/bin </span></span></code></pre></div><h3 id="test-to-ensure-that-the-version-you-installed-is-up-to-date">Test to ensure that the version you installed is up-to-date</h3> <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre><code> $ vz version </code></pre> </div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script> <p>The resulting output should be similar to the following. <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre><code>Version: master BuildDate: 2023-02-12T21:07:26Z GitCommit: cb0778bbf7a2cd90e1ae8458abd242f9da27a100 </code></pre> </div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <h2 id="use-the-vz-cli">Use the vz CLI</h2> <p>Verrazzano provides a command-line tool for managing a Verrazzano environment using the Verrazzano and Kubernetes API.</p> <p>Common use cases include installing, upgrading, and uninstalling Verrazzano, as well as analyzing failures in a running Verrazzano environment.</p> <h3 id="usage-information">Usage information</h3> <p>Use the following syntax to run <code>vz</code> commands from your terminal window. <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre><code>vz [command] [flags] </code></pre> </div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <h3 id="available-commands">Available commands</h3> <table> <thead> <tr> <th>Command</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td><code>analyze</code></td> <td>Analyze cluster</td> </tr> <tr> <td><code>bug-report</code></td> <td>Collect information from the cluster to report an issue</td> </tr> <tr> <td><code>completion</code></td> <td>Generate the autocompletion script for the specified shell</td> </tr> <tr> <td><code>help</code></td> <td>Help about any command</td> </tr> <tr> <td><code>install</code></td> <td>Install Verrazzano</td> </tr> <tr> <td><code>status</code></td> <td>Status of the Verrazzano installation and access endpoints</td> </tr> <tr> <td><code>uninstall</code></td> <td>Uninstall Verrazzano</td> </tr> <tr> <td><code>upgrade</code></td> <td>Upgrade Verrazzano</td> </tr> <tr> <td><code>version</code></td> <td>Verrazzano version information</td> </tr> </tbody> </table> <h3 id="available-flags">Available Flags</h3> <p>These flags apply to all the commands.</p> <table> <thead> <tr> <th>Flag</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td><code>--context string</code></td> <td>The name of the kubeconfig file context to use.</td> </tr> <tr> <td><code>-h</code>, <code>--help</code></td> <td>Help for <code>vz</code>.</td> </tr> <tr> <td><code>--kubeconfig string</code></td> <td>Path to the kubeconfig file to use.</td> </tr> </tbody> </table> /docs/setup/install/prepare/platforms/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/setup/install/prepare/platforms/