Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HPCC-30046 Minor Changes to Containerized Doc #17657

Merged
merged 1 commit into from
Aug 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
few fundamental changes to note.</para>

<sect2 id="processesandpods">
<title>Processes and pods, not machines</title>
<title>Processes and Pods, not Machines</title>

<para>Anyone familiar with the existing configuration system will know
that part of the configuration involves creating instances of each
Expand All @@ -149,7 +149,7 @@
</sect2>

<sect2 id="helmcharts001">
<title>Helm charts</title>
<title>Helm Charts</title>

<para>In the containerized world, the information that the operator
needs to supply to configure an HPCC Systems environment is greatly
Expand Down Expand Up @@ -204,7 +204,7 @@
</sect2>

<sect2 id="topoclustersvsqueues">
<title>Topology settings – Clusters vs queues</title>
<title>Topology Settings – Clusters vs Queues</title>

<para>In bare-metal deployments, there is a section called <emphasis
role="strong">Topology</emphasis> where the various queues that
Expand Down
31 changes: 17 additions & 14 deletions docs/EN_US/ContainerizedHPCC/ContainerizedMods/AzureDeployment.xml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
clusters in one resource group can cause confusion and difficulties to
manage. Unless you or someone in your organization has already created a
resource group and specified to work in that pre-existing resource
group, you will need to create one. </para>
group, you will need to create one.</para>

<para>To create a new resource group, you must choose a name and an
Azure location. Additionally, you may choose to use tags for ease of
Expand Down Expand Up @@ -202,7 +202,7 @@
only for the core AKS services and workloads. You will need to use a
node taint on the newly created system node pool. Since you can't add
taints to any pre-existing node pool, swap the default system node
pool for the newly created one. </para>
pool for the newly created one.</para>

<para>In order to do this, enter the following command (all on one
line, if possible, and remove the connectors "\" as they are only
Expand Down Expand Up @@ -269,7 +269,7 @@
</sect2>

<sect2 id="AZ_Installing_TheHelmChrts">
<title>Installing the Helm charts</title>
<title>Installing the Helm Charts</title>

<para>This section will demonstrate how to fetch, modify, and deploy the
HPCC Systems charts. First we will need to access the HPCC Systems
Expand All @@ -288,15 +288,15 @@
allows you to get the latest versions of the chart dependencies.</para>

<sect3 id="AZ_INstalling-the-HPCCComponents">
<title>Installing the HPCC Systems components</title>
<title>Installing the HPCC Systems Components</title>

<para>In order for a even a basic installation to succeed, it must
have some type of storage enabled. The following steps will create
ephemeral storage using the <emphasis>azstorage</emphasis> utility
that will allow the HPCC Systems to start and run but will not
persist. To do this we will deploy the <emphasis>hpcc-azurefile
</emphasis>chart which will set up Azure's ephemeral storage for the
HPCC Systems deployment. </para>
HPCC Systems deployment.</para>

<para>To Install the hpcc-azurefile chart:</para>

Expand Down Expand Up @@ -353,7 +353,7 @@ sasha:
<para>The indentation, syntax, and characters are very
critical, please be sure those are an exact match to the above
sample. A single extra space in this file can cause
unnecessary headaches. </para>
unnecessary headaches.</para>
</listitem>
</varlistentry>
</variablelist>We can now use this
Expand Down Expand Up @@ -397,7 +397,7 @@ sasha:
key-value pair are very critical. Please be sure these are
an exact match to the sample below. A single extra space, or
missing character in this file can cause unnecessary
headaches. </entry>
headaches.</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -516,9 +516,12 @@ externally, while eclservices is designed for internal use.

<para>In order to access the HPCC Systems services you must override
these default settings to make them visible. We will now set the
visibility for eclwatch and eclqueries from local to global as in the
below example. Edit the <emphasis>myesp.yaml</emphasis> file and
change the two sections highlighted in the code examples below:</para>
visibility for <emphasis>eclwatch</emphasis> and
<emphasis>eclqueries</emphasis> from local to global as in the below
example.</para>

<para>Edit the <emphasis>myesp.yaml</emphasis> file and change the two
sections highlighted in the code examples below:</para>

<programlisting>esp:
- name: eclwatch
Expand All @@ -536,7 +539,7 @@ externally, while eclservices is designed for internal use.
<emphasis role="bold">visibility: global</emphasis>
## Annotations can be specified on a service - for example to specify provider-specific i</programlisting>

<para></para>
<para> </para>

<programlisting>- name: eclqueries
application: eclqueries
Expand All @@ -554,7 +557,7 @@ externally, while eclservices is designed for internal use.
</sect3>

<sect3 id="AZ-Install-theCustomizedHPCC-Chart">
<title>Install the customized HPCC Systems chart</title>
<title>Install the Customized HPCC Systems Chart</title>

<para>This section will install the delivered HPCC Systems chart where
we supply the <emphasis>myesp.yaml</emphasis> and
Expand Down Expand Up @@ -654,7 +657,7 @@ mydali ClusterIP 10.0.195.229 &lt;none&gt; 7070/TCP 11m
losing your data.</para>

<para>The various storage options and strategies are discussed elsewhere
in addition to the HPCC Systems documentation. </para>
in addition to the HPCC Systems documentation.</para>

<sect3>
<title>Stopping Your HPCC Systems Cluster</title>
Expand All @@ -680,7 +683,7 @@ mydali ClusterIP 10.0.195.229 &lt;none&gt; 7070/TCP 11m
<programlisting>helm uninstall myhpcccluster</programlisting>

<para>This will remove the HPCC Systems cluster named
&lt;myhpcccluster&gt; you had previously deployed. </para>
&lt;myhpcccluster&gt; you had previously deployed.</para>
</sect3>

<sect3>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
a manner that corresponds best to your operational strategy.</para>

<sect3 id="YML_HPCCSystemsServices">
<title>The Systems services</title>
<title>The Systems Services</title>

<para>Most of the HPCC Systems components have a service definition
entry, similar to the resources entry. All the components that have
Expand Down Expand Up @@ -798,8 +798,7 @@

<para>You can configure your HPCC Systems cloud deployment to access
logical files from other remote environments. You configure this
remote storage by adding a "remote" section to your helm chart.
</para>
remote storage by adding a "remote" section to your helm chart.</para>

<para>The <emphasis>storage.remote</emphasis> section is a list of
named remote environments that define the remote service url and a
Expand Down Expand Up @@ -1237,7 +1236,7 @@ thor:
</informaltable></para>

<para>The following example sets the environment variable to skip
Python cleanup on the Thor component: </para>
Python cleanup on the Thor component:</para>

<para><programlisting>thor:
env:
Expand Down Expand Up @@ -1300,7 +1299,7 @@ thor:
containerized version of the HPCC Systems platform.</para>

<sect2 id="TheValuesYamlFileStruct">
<title>The <emphasis>values.yaml</emphasis> file structure</title>
<title>The <emphasis>values.yaml</emphasis> File Structure</title>

<para>The <emphasis>values.yaml</emphasis> file is a YAML file which is
a format frequently used for configuration files. The construct that
Expand Down Expand Up @@ -1416,7 +1415,7 @@ global:
</sect2>

<sect2 id="HPCCSystems_YAML_Usage">
<title>HPCC Systems Values.yaml File Usage</title>
<title>HPCC Systems values.yaml File Usage</title>

<para>The HPCC Systems <emphasis>values.yaml</emphasis> file is used by
the Helm chart to control how HPCC Systems is deployed. The stock
Expand Down Expand Up @@ -1462,7 +1461,7 @@ global:
any properties defined for bundles.</para>

<sect4 id="GenerallyApplicable">
<title>Generally applicable</title>
<title>Generally Applicable</title>

<para>These items are generally applicable for our HPCC Systems Helm
YAML files.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ global:
</sect3>

<sect3 id="ProvideAADRegisteredApplicationInformation">
<title>Provide AAD registered application information</title>
<title>Provide AAD Registered Application Information</title>

<para>HPCC Systems logAccess requires access to the AAD tenant,
client, token, and target workspace ID via secure secret object. The
Expand Down Expand Up @@ -688,7 +688,7 @@ ContainerLog
</sect2>

<sect2>
<title>Asychronous logging configuration</title>
<title>Asychronous Logging Configuration</title>

<para>By default log entries will be created and logged asynchronously,
so as not to block the client that is logging. Log entries will be held
Expand Down
Loading