Readd entity work from #619 lost during merge of #626

SUSE · Dec 13, 2019 · 9c9ae66 · 9c9ae66
1 parent e248bef
commit 9c9ae66
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 35 deletions.
diff --git a/xml/cap_overview.xml b/xml/cap_overview.xml
@@ -78,8 +78,7 @@
 
   <para>
    See all product manuals for &productname; 1.x at
-   <link xlink:href="https://documentation.suse.com/suse-cap/1/">SUSE
-   Cloud Application Platform 1</link>.
+   <link xlink:href="https://documentation.suse.com/suse-cap/1/">&productname; 1</link>.
   </para>
 
   <tip>
@@ -117,18 +116,18 @@
   </para>
 
   <para>
-   All Docker images for the &sle; builds are hosted on
+   All &docker; images for the &sle; builds are hosted on
    <literal>registry.suse.com</literal>. These are the commercially-supported
    images. (Community-supported images for &opensuse; are hosted on
-   <link xlink:href="https://hub.docker.com"> Docker Hub</link>.) Product
+   <link xlink:href="https://hub.docker.com">&docker; Hub</link>.) Product
    manuals on
-   <link xlink:href="https://documentation.suse.com/suse-cap/1/">SUSE
-   Doc: SUSE Cloud Application Platform 1</link> refer to the
+   <link xlink:href="https://documentation.suse.com/suse-cap/1/">&suse;
+   Doc: &productname; 1</link> refer to the
    commercially-supported &sle; version.
   </para>
 
   <para>
-   &cap; is designed to run on any Kubernetes cluster. This guide describes how
+   &cap; is designed to run on any &kube; cluster. This guide describes how
    to deploy it on:
   </para>
   <!-- Platforms covered by guide -->
@@ -215,8 +214,8 @@
 
   <para>
    The principle interface and API for deploying applications to &productname;
-   is &scf;. Most Cloud Foundry distributions run on virtual machines managed
-   by &bosh;. &scf; runs in SUSE Linux Enterprise containers managed by &kube;.
+   is &scf;. Most &cf; distributions run on virtual machines managed
+   by &bosh;. &scf; runs in &sle; containers managed by &kube;.
    Containerizing the components of the platform itself has these advantages:
   </para>
 
@@ -238,17 +237,16 @@
   </itemizedlist>
 
   <para>
-   &scf; packages upstream Cloud Foundry &bosh; releases to produce containers
+   &scf; packages upstream &cf; &bosh; releases to produce containers
    and configurations which are deployed to &kube; clusters using &helm;.
   </para>
  </sect1>
  <sect1 xml:id="sec-cap-requirements">
   <title>Minimum Requirements</title>
 
   <para>
-   This guide details the steps for deploying &scf; on &suse; &caasp;, and on
-   supported &kube; environments such as Microsoft Azure Kubernetes Service
-   (AKS), and Amazon Elastic Container Service for Kubernetes (EKS). &suse;
+   This guide details the steps for deploying &scf; on &caasp;, and on
+   supported &kube; environments such as &aks-full;, &gke-full;, and &eks-full;.
    &caasp; is a specialized application development and hosting platform built
    on the &susemicros; container host operating system, container orchestration
    with &kube;, and &salt; for automating installation and configuration.
@@ -258,7 +256,7 @@
    <title>Required Knowledge</title>
    <para>
     Installing and administering &productname; requires knowledge of Linux,
-    &docker;, &kube;, and your &kube; platform (for example &suse; &caasp;,
+    &docker;, &kube;, and your &kube; platform (for example &caasp;,
     AKS, EKS, OpenStack). You must plan resource allocation and network
     architecture by taking into account the requirements of your &kube;
     platform in addition to &scf; requirements. &scf; is a discrete component
@@ -270,16 +268,16 @@
   <para>
    You may create a minimal deployment on four &kube; nodes for testing.
    However, this is insufficient for a production deployment. A supported
-   deployment includes &scf; installed on &suse; &caasp;, Amazon EKS, or Azure
-   AKS. You also need a storage back-end such as &ses; or NFS, a DNS/DHCP
+   deployment includes &scf; installed on &caasp;, &eks;, &gke;, or &aks;.
+   You also need a storage back-end such as &ses; or NFS, a DNS/DHCP
    server, and an Internet connection to download additional packages during
    installation and ~10 GB of &docker; images on each &kube; worker after
    installation. (See <xref linkend="cha-cap-depl-caasp"/>.)
   </para>
 
   <para>
    A production deployment requires considerable resources. &productname;
-   includes an entitlement of &suse; &caasp; and &ses;. &ses; alone has
+   includes an entitlement of &caasp; and &ses;. &ses; alone has
    substantial requirements; see the
    <link xlink:href="https://www.suse.com/products/suse-enterprise-storage/">Tech
    Specs</link> for details. &suse; &caasp; requires a minimum of four hosts:
@@ -350,7 +348,7 @@
   </itemizedlist>
 
   <para>
-   &suse; &caasp; is a Container as a Service platform, and &productname; is a
+   &caasp; is a Container as a Service platform, and &productname; is a
    PaaS.
   </para>
 
@@ -369,7 +367,7 @@
   </figure>
 
   <para>
-   <xref linkend="fig-cap-containerized"/> illustrates how &suse; &caasp; and
+   <xref linkend="fig-cap-containerized"/> illustrates how &caasp; and
    &productname; containerize the platform itself.
   </para>
 
@@ -426,7 +424,7 @@
     </listitem>
     <listitem>
      <para>
-      Docker Trusted Registry owned by SUSE.
+      &docker; Trusted Registry owned by &suse;.
      </para>
     </listitem>
     <listitem>
@@ -436,7 +434,7 @@
     </listitem>
     <listitem>
      <para>
-      &helm;, the &kube; package manager, which includes Tiller, the &helm;
+      &helm;, the &kube; package manager, which includes &tiller;, the &helm;
       server, and the <command>helm</command> command line client.
      </para>
     </listitem>
@@ -638,7 +636,7 @@
      <term>mysql</term>
      <listitem>
       <para>
-       A MariaDB server and component to route requests to replicas. (A
+       A &mariadb; server and component to route requests to replicas. (A
        separate copy is deployed for <literal>uaa</literal>.)
       </para>
      </listitem>
@@ -672,7 +670,7 @@
      <term>router</term>
      <listitem>
       <para>
-       Routes application and API traffic. Exposed using a Kubernetes service.
+       Routes application and API traffic. Exposed using a &kube; service.
       </para>
      </listitem>
     </varlistentry>
@@ -772,13 +770,13 @@
        <entry>External</entry>
        <entry>HTTPS</entry>
        <entry>Internal &kube; components</entry>
-       <entry>Download Docker Images</entry>
+       <entry>Download &docker; Images</entry>
        <entry>Refer to registry.suse.com</entry>
        <entry>Refer to registry.suse.com</entry>
        <entry>registry.suse.com</entry>
-       <entry>Docker images</entry>
+       <entry>&docker; images</entry>
        <entry>None</entry>
-       <entry>Docker images that make up &cap; are downloaded</entry>
+       <entry>&docker; images that make up &cap; are downloaded</entry>
       </row>
       <row>
        <entry>3</entry>

diff --git a/xml/entity-decl.ent b/xml/entity-decl.ent
@@ -2,8 +2,8 @@
 <!-- Product-specific                                                       -->
 <!-- ====================================================================== -->
 
-<!ENTITY productname    "&suse; Cloud Application Platform">
-<!ENTITY productnamereg "&suse;&reg; Cloud Application Platform">
+<!ENTITY productname    "&suse; &cap;">
+<!ENTITY productnamereg "&suse;&reg; &cap;">
 <!ENTITY productnumber  "1.5.1">
 <!ENTITY github.url     "https://github.com/SUSE/doc-cap">
 <!ENTITY cap            "Cloud Application Platform">
@@ -24,7 +24,7 @@
 
 
 
-<!ENTITY caasp        "CaaS Platform">
+<!ENTITY caasp        "&suse; CaaS Platform">
 <!ENTITY susecaaspreg "&suse;&reg; CaaS Platform">
 <!ENTITY cf           "Cloud Foundry">
 <!ENTITY scf          "&suse; Cloud Foundry">
@@ -147,10 +147,10 @@
 <!ENTITY aareg         "<phrase xmlns='http://docbook.org/ns/docbook'>AppArmor&reg;</phrase>">
 <!ENTITY sudo          "<command xmlns='http://docbook.org/ns/docbook'>sudo</command>">
 <!ENTITY pk            "PolKit">
-<!ENTITY mariadb       "Maria DB">
+<!ENTITY mariadb       "MariaDB">
 <!ENTITY selnx         "SELinux">
 <!ENTITY postgresql    "PostgreSQL">
-<!ENTITY mysql         "MariaDB">
+<!ENTITY mysql         "MySQL">
 <!ENTITY jeos          "JeOS"><!-- Just enough OS -->
 <!ENTITY stap          "SystemTap">
 <!ENTITY oprof         "OProfile">
@@ -170,11 +170,11 @@
 
 <!ENTITY ms            "Microsoft">
 <!ENTITY aks           "&ms; AKS">
-<!ENTITY aks-full      "&ms; Azure Kubernetes Service">
+<!ENTITY aks-full      "&ms; Azure &kube; Service">
 <!ENTITY eks           "Amazon EKS">
-<!ENTITY eks-full      "Amazon Elastic Kubernetes Service">
+<!ENTITY eks-full      "Amazon Elastic &kube; Service">
 <!ENTITY gke           "Google GKE">
-<!ENTITY gke-full      "Google Kubernetes Engine">
+<!ENTITY gke-full      "Google &kube; Engine">
 
 <!-- ============================================================= -->
 <!-- Virtualization                                                -->

diff --git a/xml/sec_cf_usb_url.xml b/xml/sec_cf_usb_url.xml
@@ -13,7 +13,7 @@
  <para>
   This change is only applicable for upgrades from &cap; 1.2.1 to &cap; 1.3 and
   upgrades from &cap; 1.3 to &cap; 1.3.1. The URL of the internal cf-usb broker
-  endpoint has changed. Brokers for &postgresql; and &mariadb; that use cf-usb will
+  endpoint has changed. Brokers for &postgresql; and &mysql; that use cf-usb will
   require the following manual fix after upgrading to reconnect with SCF/CAP:
  </para>
  <para>