deploy: 354a29e

sles4sap/ipaddr2.html

@@ -16,6 +16,7 @@
     <ul>
       <li><a href="#ipaddr2_azure_resource_group">ipaddr2_azure_resource_group</a></li>
       <li><a href="#ipaddr2_azure_storage_account">ipaddr2_azure_storage_account</a></li>
+      <li><a href="#ipaddr2_cloudinit_create">ipaddr2_cloudinit_create</a></li>
       <li><a href="#ipaddr2_infra_deploy">ipaddr2_infra_deploy</a></li>
       <li><a href="#ipaddr2_bastion_pubip">ipaddr2_bastion_pubip</a></li>
       <li><a href="#ipaddr2_bastion_ssh_addr">ipaddr2_bastion_ssh_addr</a></li>
@@ -27,8 +28,8 @@
       <li><a href="#ipaddr2_os_sanity">ipaddr2_os_sanity</a></li>
       <li><a href="#ipaddr2_cluster_sanity">ipaddr2_cluster_sanity</a></li>
       <li><a href="#ipaddr2_os_connectivity_sanity">ipaddr2_os_connectivity_sanity</a></li>
-      <li><a href="#ipaddr2_os_cloud_init_sanity">ipaddr2_os_cloud_init_sanity</a></li>
-      <li><a href="#ipaddr2_os_cloud_init_logs">ipaddr2_os_cloud_init_logs</a></li>
+      <li><a href="#ipaddr2_cloudinit_sanity">ipaddr2_cloudinit_sanity</a></li>
+      <li><a href="#ipaddr2_cloudinit_logs">ipaddr2_cloudinit_logs</a></li>
       <li><a href="#ipaddr2_os_network_sanity">ipaddr2_os_network_sanity</a></li>
       <li><a href="#ipaddr2_os_ssh_sanity">ipaddr2_os_ssh_sanity</a></li>
       <li><a href="#ipaddr2_ssh_bastion_assert_script_run">ipaddr2_ssh_bastion_assert_script_run</a></li>
@@ -69,10 +70,32 @@ <h2 id="ipaddr2_azure_resource_group">ipaddr2_azure_resource_group</h2>
 
 <h2 id="ipaddr2_azure_storage_account">ipaddr2_azure_storage_account</h2>
 
-<pre><code>my $storage account = ipaddr2_azure_storage_account();</code></pre>
+<pre><code>my $storage_account = ipaddr2_azure_storage_account();</code></pre>
 
 <p>Get a unique storage account name. Not including the jobId result in error like: The storage account named ip2tstorageaccount already exists under the subscription</p>
 
+<h2 id="ipaddr2_cloudinit_create">ipaddr2_cloudinit_create</h2>
+
+<pre><code>my $cloud_init_file = ipaddr2_cloudinit_create();</code></pre>
+
+<p>Create the cloud-init.txt profile file</p>
+
+<dl>
+
+<dt id="scc_code---Optional-argument.-If-present-registration-will-be-added-in-bootcmd-section-of-the-cloud-init-profile-file.-Having-registration-enabled-is-particularly-important-for-BYOS-images:-this-profile-also-try-to-install-nginx-this-stage-needs-a-previous-registration"><b>scc_code</b> - Optional argument. If present, registration will be added in bootcmd section of the cloud-init profile file. Having registration enabled is particularly important for BYOS images: this profile also try to install nginx, this stage needs a previous registration.</dt>
+<dd>
+
+</dd>
+<dt id="nginx_root---Optional-argument:-default-is-srv-www-htdocs.-This-argument-allow-to-overwrite-the-location-where-the-index.html-generated-by-the-test-and-used-to-identify-each-node-is-stored.-As-the-test-is-not-using-any-nginx-configuration-file-this-location-has-to-match-to-the-default-root-folder-configured-by-the-particular-version-of-nginx-installed-in-the-SUT.-Default-value-is-was-value-for-nginx-installable-in-15sp5-and-sp6.-12sp5-needs-usr-share-nginx-html"><b>nginx_root</b> - Optional argument: default is <b>/srv/www/htdocs</b>. This argument allow to overwrite the location where the index.html, generated by the test and used to identify each node, is stored. As the test is not using any nginx configuration file, this location has to match to the default root folder configured by the particular version of nginx installed in the SUT. Default value is/was value for nginx installable in 15sp5 and sp6. 12sp5 needs /usr/share/nginx/html</dt>
+<dd>
+
+</dd>
+<dt id="external_repo---Optional-argument:-allow-to-add-a-PackageHub-product"><b>external_repo</b> - Optional argument: allow to add a PackageHub product</dt>
+<dd>
+
+</dd>
+</dl>
+
 <h2 id="ipaddr2_infra_deploy">ipaddr2_infra_deploy</h2>
 
 <pre><code>my $rg = ipaddr2_infra_deploy();</code></pre>
@@ -95,17 +118,13 @@ <h2 id="ipaddr2_infra_deploy">ipaddr2_infra_deploy</h2>
 <dd>
 
 </dd>
-<dt id="cloudinit---enable-cloud-init-features-if-1.-This-feature-is-used-to-install-the-web-server-using-cloud-init-by-providing-an-external-cloud-init-config-file.-This-feature-cannot-be-used-for-BYOS-images-as-installing-additional-packages-is-not-supported-before-the-image-registration.-This-feature-could-be-problematic-when-testing-maintenance-update:-problem-is-that-the-config-file-also-perform-a-zypper-patch-.-It-happens-at-the-first-boot-during-the-deployment-so-before-any-other-part-of-the-test-can-add-additional-repo-to-test"><b>cloudinit</b> - enable cloud-init features if 1. This feature is used to install the web server using cloud-init, by providing an external cloud-init config file. This feature cannot be used for BYOS images as installing additional packages is not supported before the image registration. This feature could be problematic when testing maintenance update: problem is that the config file also perform a `zypper patch`. It happens at the first boot during the deployment so before any other part of the test can add additional repo to test.</dt>
+<dt id="cloudinit_profile---filename-of-the-cloud-init-profile.-Usually-this-one-is-the-return-value-of-ipaddr2_cloudinit_create.-Presence-of-this-optional-argument-also-enable-cloud-init-features-in-various-deployment-stages"><b>cloudinit_profile</b> - filename of the cloud-init profile. Usually this one is the return value of <b>ipaddr2_cloudinit_create</b>. Presence of this optional argument also enable cloud-init features in various deployment stages.</dt>
 <dd>
 
 </dd>
 <dt id="trusted_launch---Enable-or-disable-Trusted-Launch.-Default-1:-Enabled.-If-configured-to-0-the-result-in-az-vm-create-is-executed-with---security-type-Standard"><b>trusted_launch</b> - Enable or disable Trusted Launch. Default 1: Enabled. If configured to 0 the result in az vm create is executed with &#39;--security-type Standard&#39;</dt>
 <dd>
 
-</dd>
-<dt id="scc_code---if-cloudinit-is-enabled-it-is-also-possible-to-add-register-command-in-it.-This-argument-is-just-ignored-if-cloudinit-is-0.-This-argument-become-mandatory-is-cloudinit-is-1-and-image-is-BYOS.-This-is-because-cloud-init-also-try-to-install-nginx-but-installing-packages-is-not-possible-for-BYOS-images-before-registering"><b>scc_code</b> - if cloudinit is enabled, it is also possible to add register command in it. This argument is just ignored if cloudinit is 0. This argument become mandatory is cloudinit is 1 and image is BYOS. This is because cloud-init also try to install nginx, but installing packages is not possible for BYOS images, before registering.</dt>
-<dd>
-
 </dd>
 </dl>
 
@@ -271,9 +290,9 @@ <h2 id="ipaddr2_os_connectivity_sanity">ipaddr2_os_connectivity_sanity</h2>
 </dd>
 </dl>
 
-<h2 id="ipaddr2_os_cloud_init_sanity">ipaddr2_os_cloud_init_sanity</h2>
+<h2 id="ipaddr2_cloudinit_sanity">ipaddr2_cloudinit_sanity</h2>
 
-<pre><code>ipaddr2_os_cloud_init_sanity()</code></pre>
+<pre><code>ipaddr2_cloudinit_sanity()</code></pre>
 
 <p>Run some checks about cloud-init</p>
 
@@ -285,9 +304,9 @@ <h2 id="ipaddr2_os_cloud_init_sanity">ipaddr2_os_cloud_init_sanity</h2>
 </dd>
 </dl>
 
-<h2 id="ipaddr2_os_cloud_init_logs">ipaddr2_os_cloud_init_logs</h2>
+<h2 id="ipaddr2_cloudinit_logs">ipaddr2_cloudinit_logs</h2>
 
-<pre><code>ipaddr2_os_cloud_init_logs()</code></pre>
+<pre><code>ipaddr2_cloudinit_logs()</code></pre>
 
 <p>Collect some cloud-init related logs</p>
 
@@ -547,6 +566,14 @@ <h2 id="ipaddr2_configure_web_server">ipaddr2_configure_web_server</h2>
 <dt id="bastion_ip---Public-IP-address-of-the-bastion.-Calculated-if-not-provided.-Providing-it-as-an-argument-is-recommended-in-order-to-avoid-having-to-query-Azure-to-get-it21"><b>bastion_ip</b> - Public IP address of the bastion. Calculated if not provided. Providing it as an argument is recommended in order to avoid having to query Azure to get it.</dt>
 <dd>
 
+</dd>
+<dt id="nginx_root---Optional-argument:-default-is-srv-www-htdocs.-This-argument-allows-to-overwrite-the-location-where-the-index.html-generated-by-the-test-and-used-to-identify-each-node-is-stored.-As-the-test-is-not-using-any-nginx-configuration-file-this-location-has-to-match-to-the-default-root-folder-configured-by-the-particular-version-of-nginx-installed-in-the-SUT.-Default-value-is-was-value-for-nginx-installable-in-15sp5-and-sp6.-12sp5-needs-usr-share-nginx-html"><b>nginx_root</b> - Optional argument: default is <b>/srv/www/htdocs</b>. This argument allows to overwrite the location where the index.html, generated by the test and used to identify each node, is stored. As the test is not using any nginx configuration file, this location has to match to the default root folder configured by the particular version of nginx installed in the SUT. Default value is/was value for nginx installable in 15sp5 and sp6. 12sp5 needs /usr/share/nginx/html</dt>
+<dd>
+
+</dd>
+<dt id="external_repo---Optional-argument:-allow-to-add-a-PackageHub-product1"><b>external_repo</b> - Optional argument: allow to add a PackageHub product</dt>
+<dd>
+
 </dd>
 </dl>