Merge pull request #619 from SUSE/cleanup-entities

Clean up entities

xml/app_psps.xml

@@ -15,8 +15,8 @@
  <para>
   &productname; 1.3.1 introduces built-in support for Pod Security Policies
   (PSPs), which are provided via &helm; charts and are set up automatically,
-  unlike older releases which require manual PSP setup. &suse; &caasp; and
-  Microsoft AKS both require PSPs for &cap; to operate correctly. This section
+  unlike older releases which require manual PSP setup. &caasp; and
+  &aks; both require PSPs for &cap; to operate correctly. This section
   provides instructions for configuring and applying the appropriate PSPs to
   older &cap; releases.
  </para>

xml/app_scf_values_yaml.xml

@@ -1044,7 +1044,7 @@ sizing:
   #   SCF patches for upstream bugs
   #
   # - cloud_controller_ng: The Cloud Controller provides primary Cloud Foundry
-  #   API that is by the CF CLI. The Cloud Controller uses a database to keep
+  #   API that is by the &cfcli;. The Cloud Controller uses a database to keep
   #   tables for organizations, spaces, apps, services, service instances, user
   #   roles, and more. Typically multiple instances of Cloud Controller are load
   #   balanced.

xml/cap_admin_app_autoscaler.xml

@@ -40,7 +40,7 @@
 
    <listitem>
     <para>
-     The Cloud Foundry CLI AutoScaler Plug-in, see <link xlink:href="https://github.com/cloudfoundry-incubator/app-autoscaler-cli-plugin"/>
+     The &cf; CLI AutoScaler Plug-in, see <link xlink:href="https://github.com/cloudfoundry-incubator/app-autoscaler-cli-plugin"/>
     </para>
     <para>
      The plugin can be installed by running the following command:

xml/cap_admin_backup-restore.xml

@@ -62,7 +62,7 @@
    <listitem>
     <para>
      Buildpacks are not saved. Applications using custom buildpacks not
-     available on the target SUSE Cloud Foundry instance will not be restored.
+     available on the target &scf; instance will not be restored.
      Custom buildpacks must be managed separately, and relevant buildpacks must
      be in place before the affected applications are restored.
     </para>
@@ -673,7 +673,7 @@
       defined on the source cluster. This value is defined in
       <filename>/var/vcap/jobs/cloud_controller_ng/config/cloud_controller_ng.yml</filename>
       of the <literal>api-group-0</literal> pod and also found in various
-      tables of the MySQL database.
+      tables of the &mysql; database.
      </para>
      <para>
       Begin by examining the configuration file for

xml/cap_admin_buildpacks.xml

@@ -360,14 +360,14 @@ another_ruby_buildpack   11         true      false    ruby-buildpack-v1.7.41.1-
     Offline buildpacks can be created using the
     <link xlink:href="https://github.com/SUSE/cf-buildpack-packager-docker">cf-buildpack-packager-docker</link>
     tool, which is available as a
-    <link xlink:href="https://www.docker.com/">Docker</link> image. The only
-    requirement to use this tool is a system with Docker support.
+    <link xlink:href="https://www.docker.com/">&docker;</link> image. The only
+    requirement to use this tool is a system with &docker; support.
    </para>
 
    <important>
     <title>Disclaimer</title>
     <para>
-     Some Cloud Foundry buildpacks can reference binaries with proprietary or
+     Some &cf; buildpacks can reference binaries with proprietary or
      mutually incompatible open source licenses which cannot be distributed
      together as offline/cached buildpack archives. Operators who wish to
      package and maintain offline buildpacks will be responsible for any
@@ -432,7 +432,7 @@ another_ruby_buildpack   11         true      false    ruby-buildpack-v1.7.41.1-
    <procedure>
     <step>
      <para>
-      Build the latest released SUSE Ruby buildpack for the &sle; 15 stack:
+      Build the latest released &suse; Ruby buildpack for the &sle; 15 stack:
      </para>
 <screen>&prompt.user;docker run --interactive --tty --rm -v $PWD:/out splatform/cf-buildpack-packager <replaceable>SUSE</replaceable> <replaceable>ruby</replaceable> <replaceable>""</replaceable> <replaceable>sle15</replaceable></screen>
     </step>

xml/cap_admin_ccdb_key_rotation.xml

@@ -159,7 +159,7 @@ MariaDB [(none)]> select name, encrypted_environment_variables, encryption_key_l
     <term>droplets</term>
     <listitem>
      <para>
-      May contain Docker registry passwords
+      May contain &docker; registry passwords
      </para>
     </listitem>
    </varlistentry>
@@ -175,7 +175,7 @@ MariaDB [(none)]> select name, encrypted_environment_variables, encryption_key_l
     <term>packages</term>
     <listitem>
      <para>
-      May contain Docker registry passwords
+      May contain &docker; registry passwords
      </para>
     </listitem>
    </varlistentry>
@@ -250,7 +250,7 @@ MariaDB [(none)]> select name, encrypted_environment_variables, encryption_key_l
      <listitem>
       <para>
        <command>cf delete</command>, then <command>cf push</command> the app
-       (Docker apps with registry password)
+       (&docker; apps with registry password)
       </para>
      </listitem>
     </varlistentry>

xml/cap_admin_credhub.xml

@@ -81,7 +81,7 @@
   <para>
    On occasion, the <literal>credhub</literal> pod may fail to start due to
    database migration failures; this has been spotted intermittently on
-   Azure Kubernetes Service and to a lesser extent, other public clouds.
+   &aks-full; and to a lesser extent, other public clouds.
    In these situations, manual intervention is required to track the last
    completed transaction in <literal>credhub_user</literal> database and
    update the flyway schema history table with the record of the last

xml/cap_admin_minibroker.xml

@@ -20,7 +20,7 @@
   <link xlink:href="https://www.openservicebrokerapi.org/">OSBAPI compliant
   broker</link> created by members of the
   <link xlink:href="https://github.com/osbkit">Microsoft Azure team</link>. It
-  provides a simple method to provision service brokers on Kubernetes clusters.
+  provides a simple method to provision service brokers on &kube; clusters.
  </para>
  <important>
   <title>Minibroker Upstream Services</title>
@@ -40,7 +40,7 @@
   <procedure>
    <step>
     <para>
-     Minibroker is deployed using a &helm; chart. Ensure your SUSE &helm; chart
+     Minibroker is deployed using a &helm; chart. Ensure your &suse; &helm; chart
      repository contains the most recent Minibroker chart:
     </para>
 <screen>&prompt.user;helm repo update</screen>
@@ -66,7 +66,7 @@
       </thead>
       <tbody>
        <row>
-        <entry>MariaDB</entry>
+        <entry>&mariadb;</entry>
 	<entry>4.3.0</entry>
         <entry>10.1.34</entry>
        </row>
@@ -76,7 +76,7 @@
         <entry>4.0.6</entry>
        </row>
        <row>
-        <entry>PostgreSQL</entry>
+        <entry>&postgresql;</entry>
 	<entry>6.2.1</entry>
         <entry>11.5.0</entry>
        </row>
@@ -187,15 +187,15 @@ TIP:  Use 'cf marketplace -s SERVICE' to view descriptions of individual plans o
       </thead>
       <tbody>
        <row>
-        <entry>MariaDB</entry>
+        <entry>&mariadb;</entry>
         <entry>3306</entry>
        </row>
        <row>
         <entry>MongoDB</entry>
         <entry>27017</entry>
        </row>
        <row>
-        <entry>PostgreSQL</entry>
+        <entry>&postgresql;</entry>
         <entry>5432</entry>
        </row>
        <row>
@@ -276,9 +276,9 @@ minibroker-minibroker-5865f66bb8-6dxm7          2/2       Running            0
   </procedure>
 
   <important>
-   <title>Database Names for PostgreSQL and MariaDB Instances</title>
+   <title>Database Names for &postgresql; and &mariadb; Instances</title>
    <para>
-    By default, Minibroker creates PostgreSQL and MariaDB server instances
+    By default, Minibroker creates &postgresql; and &mariadb; server instances
     without a named database. A named database is required for normal usage
     with these and will need to be added during the <command>cf
     create-service</command> step using the <literal>-c</literal> flag. For

xml/cap_admin_passwords.xml

@@ -38,13 +38,13 @@
   </listitem>
   <listitem>
    <para>
-    User logins are created (and removed) with the Cloud Foundry Client,
+    User logins are created (and removed) with the &cf; Client,
     &cfcli;
    </para>
   </listitem>
  </itemizedlist>
  <sect1 xml:id="sec-cap-passwords-cli">
-  <title>Password Management with the Cloud Foundry Client</title>
+  <title>Password Management with the &cf; Client</title>
 
   <para>
    The administrator cannot change other users' passwords. Only users may

xml/cap_admin_service_broker.xml

@@ -85,15 +85,15 @@
   <title>Prerequisites</title>
 
   <para>
-   The following examples demonstrate how to deploy service brokers for MySQL
-   and PostgreSQL with &helm;, using charts from the &suse; repository. You
+   The following examples demonstrate how to deploy service brokers for &mysql;
+   and &postgresql; with &helm;, using charts from the &suse; repository. You
    must have the following prerequisites:
   </para>
 
   <itemizedlist>
    <listitem>
     <para>
-     A working &productname; deployment with &helm; and the Cloud Foundry
+     A working &productname; deployment with &helm; and the &cf;
      command line interface (&cfcli;).
     </para>
    </listitem>
@@ -107,7 +107,7 @@
    </listitem>
    <listitem>
     <para>
-     An external MySQL or PostgreSQL installation with account credentials that
+     An external &mysql; or &postgresql; installation with account credentials that
      allow creating and deleting databases and users.
     </para>
    </listitem>
@@ -162,7 +162,7 @@
   </para>
  </sect1>
  <sect1 xml:id="sec-cap-configure-service-broker">
-  <title>Configuring the MySQL Deployment</title>
+  <title>Configuring the &mysql; Deployment</title>
 
   <para>
    Start by extracting the <literal>uaa</literal> namespace secrets name, and
@@ -241,24 +241,24 @@ kube:
     password: ""</screen>
  </sect1>
  <sect1 xml:id="sec-cap-configure-mysql">
-  <title>Deploying the MySQL Chart</title>
+  <title>Deploying the &mysql; Chart</title>
 
   <para>
-   &productname; includes charts for MySQL and PostgreSQL (see
+   &productname; includes charts for &mysql; and &postgresql; (see
    <xref linkend="sec-cap-addrepo-prod"/> for information on managing your
    &helm; repository):
   </para>
 
 &helm-search-suse;
 
   <para>
-   Create a namespace for your MySQL sidecar:
+   Create a namespace for your &mysql; sidecar:
   </para>
 
 <screen>&prompt.user;kubectl create namespace <replaceable>mysql-sidecar</replaceable></screen>
 
   <para>
-   Install the MySQL Helm chart:
+   Install the &mysql; Helm chart:
   </para>
 
 <screen>&prompt.user;helm install suse/cf-usb-sidecar-mysql \
@@ -277,18 +277,17 @@ kube:
 <screen>&prompt.user;watch kubectl get pods --namespace=mysql-sidecar</screen>
 
   <para>
-   Confirm that the new service has been added to your SUSE Cloud Applications
-   Platform installation:
+   Confirm that the new service has been added to your &productname; installation:
   </para>
 
 <screen>&prompt.user;cf marketplace</screen>
 
   <warning>
-   <title>MySQL Requires <literal>mysql_native_password</literal></title>
+   <title>&mysql; Requires <literal>mysql_native_password</literal></title>
    <para>
-    The MySQL sidecar works only with deployments that use
+    The &mysql; sidecar works only with deployments that use
     <literal>mysql_native_password</literal> as their authentication plugin.
-    This is the default for MySQL versions 8.0.3 and earlier, but later
+    This is the default for &mysql; versions 8.0.3 and earlier, but later
     versions must be started with
     <literal>--default-auth=mysql_native_password</literal> before any user
     creation. (See
@@ -297,7 +296,7 @@ kube:
   </warning>
  </sect1>
  <sect1 xml:id="sec-cap-deploy-mysql">
-  <title>Create and Bind a MySQL Service</title>
+  <title>Create and Bind a &mysql; Service</title>
 
   <para>
    To create a new service instance, use the &cf; command line client:
@@ -317,10 +316,10 @@ kube:
 <screen>&prompt.user;cf bind-service <replaceable>my_application service_instance_name</replaceable></screen>
  </sect1>
  <sect1 xml:id="sec-cap-configure-postgresql">
-  <title>Deploying the PostgreSQL Chart</title>
+  <title>Deploying the &postgresql; Chart</title>
 
   <para>
-   The PostgreSQL configuration is slightly different from the MySQL
+   The &postgresql; configuration is slightly different from the &mysql;
    configuration. The database-specific keys are named differently, and it
    requires the <varname>SERVICE_POSTGRESQL_SSLMODE</varname> key.
   </para>
@@ -385,7 +384,7 @@ kube:
   --wait</screen>
 
   <para>
-   Then follow the same steps as for the MySQL chart.
+   Then follow the same steps as for the &mysql; chart.
   </para>
  </sect1>
  <sect1 xml:id="sec-cap-remove-sidecars">
@@ -407,7 +406,7 @@ kube:
    </listitem>
    <listitem>
     <para>
-     Install the CF-USB CLI plugin for the Cloud Foundry CLI from
+     Install the CF-USB CLI plugin for the &cf; CLI from
      <link xlink:href="https://github.com/SUSE/cf-usb-plugin/releases/"/>, for
      example:
     </para>
@@ -416,7 +415,7 @@ kube:
    </listitem>
    <listitem>
     <para>
-     Configure the Cloud Foundry USB CLI plugin, using the domain you created
+     Configure the &cf; USB CLI plugin, using the domain you created
      for your &scf; deployment:
     </para>
 <screen>&prompt.user;cf usb-target https://usb.<replaceable>example.com</replaceable></screen>

xml/cap_depl_admin_notes.xml

@@ -51,9 +51,9 @@
   <para>
    The following tables list the minimum DNS requirements to run &productname;, using
    <literal>example.com</literal> as the example domain. Your DNS management is
-   platform-dependent, for example Microsoft AKS assigns IP addresses to your
-   services, which you will map to A records. Amazon EKS assigns host names,
-   which you will use to create CNAMEs. &suse; &caasp; provides the flexibility
+   platform-dependent, for example &aks; assigns IP addresses to your
+   services, which you will map to A records. &eks; assigns host names,
+   which you will use to create CNAMEs. &caasp; provides the flexibility
    to manage your name services in nearly any way you wish. The chapters for
    each platform in this guide provide the relevant DNS instructions.
 </para>

xml/cap_depl_air_gap_registry.xml

@@ -19,8 +19,8 @@
      &readmefirst;
  </important>
  <para>
-  &cap;, which consists of Docker images, is deployed to a &kube; cluster
-  through &helm;. These images are hosted on a Docker registry at
+  &cap;, which consists of &docker; images, is deployed to a &kube; cluster
+  through &helm;. These images are hosted on a &docker; registry at
   <literal>registry.suse.com</literal>. In an air gapped environment,
   <literal>registry.suse.com</literal> will not be accessible. You will need to
   create a registry, and populate it will the images used by &cap;.
@@ -39,15 +39,15 @@
   <itemizedlist>
    <listitem>
     <para>
-     The Docker Command Line. See
+     The &docker; Command Line. See
      <link xlink:href="https://docs.docker.com/engine/reference/commandline/cli/"/>
      for more information.
     </para>
    </listitem>
    <listitem>
     <para>
-     A Docker registry has been created in your air gapped environment. Refer to
-     the Docker documentation at
+     A &docker; registry has been created in your air gapped environment. Refer to
+     the &docker; documentation at
      <link xlink:href="https://docs.docker.com/registry/"/> for instructions.
     </para>
    </listitem>