diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedHPCCSystemsPlatform.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedHPCCSystemsPlatform.xml index 80a0c09b727..d1efc80c613 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedHPCCSystemsPlatform.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedHPCCSystemsPlatform.xml @@ -130,7 +130,7 @@ few fundamental changes to note. - Processes and pods, not machines + Processes and Pods, not Machines Anyone familiar with the existing configuration system will know that part of the configuration involves creating instances of each @@ -149,7 +149,7 @@ - Helm charts + Helm Charts In the containerized world, the information that the operator needs to supply to configure an HPCC Systems environment is greatly @@ -204,7 +204,7 @@ - Topology settings – Clusters vs queues + Topology Settings – Clusters vs Queues In bare-metal deployments, there is a section called Topology where the various queues that diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/AzureDeployment.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/AzureDeployment.xml index 25cb4b9eb31..d79c28452a5 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/AzureDeployment.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/AzureDeployment.xml @@ -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. + group, you will need to create one. 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 @@ -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. + pool for the newly created one. In order to do this, enter the following command (all on one line, if possible, and remove the connectors "\" as they are only @@ -269,7 +269,7 @@ - Installing the Helm charts + Installing the Helm Charts This section will demonstrate how to fetch, modify, and deploy the HPCC Systems charts. First we will need to access the HPCC Systems @@ -288,7 +288,7 @@ allows you to get the latest versions of the chart dependencies. - Installing the HPCC Systems components + Installing the HPCC Systems Components In order for a even a basic installation to succeed, it must have some type of storage enabled. The following steps will create @@ -296,7 +296,7 @@ that will allow the HPCC Systems to start and run but will not persist. To do this we will deploy the hpcc-azurefile chart which will set up Azure's ephemeral storage for the - HPCC Systems deployment. + HPCC Systems deployment. To Install the hpcc-azurefile chart: @@ -353,7 +353,7 @@ sasha: 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. + unnecessary headaches. We can now use this @@ -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. + headaches. @@ -516,9 +516,12 @@ externally, while eclservices is designed for internal use. 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 myesp.yaml file and - change the two sections highlighted in the code examples below: + visibility for eclwatch and + eclqueries from local to global as in the below + example. + + Edit the myesp.yaml file and change the two + sections highlighted in the code examples below: esp: - name: eclwatch @@ -536,7 +539,7 @@ externally, while eclservices is designed for internal use. visibility: global ## Annotations can be specified on a service - for example to specify provider-specific i - + - name: eclqueries application: eclqueries @@ -554,7 +557,7 @@ externally, while eclservices is designed for internal use. - Install the customized HPCC Systems chart + Install the Customized HPCC Systems Chart This section will install the delivered HPCC Systems chart where we supply the myesp.yaml and @@ -654,7 +657,7 @@ mydali ClusterIP 10.0.195.229 <none> 7070/TCP 11m losing your data. The various storage options and strategies are discussed elsewhere - in addition to the HPCC Systems documentation. + in addition to the HPCC Systems documentation. Stopping Your HPCC Systems Cluster @@ -680,7 +683,7 @@ mydali ClusterIP 10.0.195.229 <none> 7070/TCP 11m helm uninstall myhpcccluster This will remove the HPCC Systems cluster named - <myhpcccluster> you had previously deployed. + <myhpcccluster> you had previously deployed. diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml index dadb6b59b4b..a8d5d801290 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml @@ -164,7 +164,7 @@ a manner that corresponds best to your operational strategy. - The Systems services + The Systems Services Most of the HPCC Systems components have a service definition entry, similar to the resources entry. All the components that have @@ -798,8 +798,7 @@ 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. - + remote storage by adding a "remote" section to your helm chart. The storage.remote section is a list of named remote environments that define the remote service url and a @@ -1237,7 +1236,7 @@ thor: The following example sets the environment variable to skip - Python cleanup on the Thor component: + Python cleanup on the Thor component: thor: env: @@ -1300,7 +1299,7 @@ thor: containerized version of the HPCC Systems platform. - The <emphasis>values.yaml</emphasis> file structure + The <emphasis>values.yaml</emphasis> File Structure The values.yaml file is a YAML file which is a format frequently used for configuration files. The construct that @@ -1416,7 +1415,7 @@ global: - HPCC Systems Values.yaml File Usage + HPCC Systems values.yaml File Usage The HPCC Systems values.yaml file is used by the Helm chart to control how HPCC Systems is deployed. The stock @@ -1462,7 +1461,7 @@ global: any properties defined for bundles. - Generally applicable + Generally Applicable These items are generally applicable for our HPCC Systems Helm YAML files. diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml index 404ed59a434..5cbef70cf29 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml @@ -485,7 +485,7 @@ global: - Provide AAD registered application information + Provide AAD Registered Application Information HPCC Systems logAccess requires access to the AAD tenant, client, token, and target workspace ID via secure secret object. The @@ -688,7 +688,7 @@ ContainerLog - Asychronous logging configuration + Asychronous Logging Configuration 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