/docs/reference/ Recent content in Reference on Verrazzano Enterprise Container Platform Hugo -- gohugo.io /docs/reference/api/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/reference/api/ /docs/reference/migration/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/reference/migration/ <p>As the Verrazzano API evolves, APIs are periodically updated. When APIs evolve, the old API is deprecated and eventually removed. This document contains information that you need to know when migrating from deprecated API versions to newer and more stable API versions.</p> <h2 id="verrazzano">Verrazzano</h2> <p>The <code>install.verrazzano.io/v1alpha1</code> API version of Verrazzano resources is deprecated and will no longer be served in a future release.</p> <ul> <li>Migrate manifests and API clients to use the <code>install.verrazzano.io/v1beta1</code> API version, available since 1.4.0.</li> <li>All existing persisted objects are accessible using the new API.</li> </ul> <h4 id="notable-changes-in-installverrazzanoiov1beta1">Notable Changes In install.verrazzano.io/v1beta1</h4> <ul> <li><code>spec.components.ingress</code> is renamed to <code>spec.components.ingressNGINX</code>.</li> <li><code>spec.components.kibana</code> is renamed to <code>spec.components.opensearchDashboards</code></li> <li><code>spec.components.elasticsearch</code> is renamed to <code>spec.components.opensearch</code></li> <li><code>spec.components.fluentd.elasticsearchSecret</code> is renamed to <code>spec.components.fluentd.opensearchSecret</code></li> <li><code>spec.components.fluentd.elasticsearchURL</code> is renamed to <code>spec.components.fluentd.opensearchURL</code></li> <li><code>status.instance.kibanaUrl</code> is renamed to <code>status.instance.opensearchDashboardsUrl</code></li> <li><code>status.instance.elasticUrl</code> is renamed to <code>status.instance.opensearchUrl</code></li> <li>Use <code>spec.components.opensearch.nodes</code> instead of <code>spec.components.elasticsearch.installArgs</code>.</li> <li>Use <code>spec.components.ingressNGINX.overrides</code> instead of <code>spec.components.ingress.nginxInstallArgs</code>.</li> <li>Use <code>spec.components.istio.overrides</code> instead of <code>spec.components.istio.istioInstallArgs</code>.</li> <li>Use <code>spec.components.istio.overrides</code> instead of <code>spec.components.istio.ingress</code>.</li> <li>Use <code>spec.components.istio.overrides</code> instead of <code>spec.components.istio.egress</code>.</li> <li>Use <code>spec.components.keycloak.overrides</code> instead of <code>spec.components.keycloak.keycloakInstallArgs</code>.</li> <li>Use <code>spec.components.verrazzano.overrides</code> instead of <code>spec.components.verrazzano.installArgs</code>.</li> <li>Use <code>spec.components.authProxy.overrides</code> instead of <code>spec.components.authProxy.kubernetes</code>.</li> </ul> <h4 id="co-installing-previous-verrazzano-versions">Co-installing previous Verrazzano versions</h4> <p>After installing Verrazzano version 1.4.0 or later, and not uninstalling it <em>before</em> installing versions of Verrazzano prior to 1.4.0, will result in the following error: <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 tabindex="0"><code>The CustomResourceDefinition &#34;verrazzanos.install.verrazzano.io&#34; is invalid: status.storedVersions[0]: Invalid value: &#34;v1beta1&#34;: must appear in spec.versions </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>To resolve this error, delete the <code>verrazzanos.install.verrazzano.io</code> Custom Resource Definition: <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 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>$ kubectl delete customresourcedefinition verrazzanos.install.verrazzano.io </span></span></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="multicluster">Multicluster</h2> <p>Some of the multicluster wrappers APIs, which are part of <code>clusters.verrazzano.io/v1alpha1</code>, are deprecated and will be removed in Verrazzano v2.0.0. The APIs that will be removed are:</p> <ul> <li>MultiClusterComponent - Should be replaced with a <code>core.oam/dev/v1alpha2</code> Component resource.</li> <li>MultiClusterConfigMap - Should be replaced with a <code>core.oam/dev/v1alpha2</code> Component resource.</li> <li>MultiClusterSecret - Should be replaced with a Kubernetes Secret and referenced in the <code>spec.secrets</code> of a MultiClusterApplicationConfiguration resource.</li> </ul>