Merge pull request #569 from IBM/deployer-doc

Deployer documentation reorganize

docs/dev-doc-run.sh

@@ -1,5 +1,13 @@
 #!/bin/bash
 
+SELINUX_OPTION=""
+if hash getenforce 2>/dev/null; then
+  SELINUXSTATUS=$(getenforce)
+  if [ "$SELINUXSTATUS" != "Disabled" ]; then
+    SELINUX_OPTION=":z"
+  fi
+fi
+
 podman rm -f cpd-doc 2>/dev/null
-podman run --name cpd-doc -d -p 8000:8000 -v $PWD:/docs:Z cpd-doc:latest
-podman logs -fl
+PROCESS=$(podman run --name cpd-doc -d -p 8000:8000 -v $PWD:/docs${SELINUX_OPTION} cpd-doc:latest)
+podman logs -f ${PROCESS}

docs/mkdocs.yml

@@ -24,7 +24,6 @@ nav:
   - 'Installing Cloud Pak Deployer': ./05-install/install.md
   - 'Using Cloud Pak Deployer':
     - Overview: ./10-use-deployer/1-overview/overview.md
-    - Configure: ./10-use-deployer/2-configure/configure.md
     - Run:
       - 'Running Cloud Pak Deployer': ./10-use-deployer/3-run/run.md
       - 'Existing OpenShift': ./10-use-deployer/3-run/existing-openshift.md
@@ -129,6 +128,7 @@ extra_css:
 plugins:
   - search
   - table-reader
+  - open-in-new-tab
   # - git-revision-date-localized:
   #     fallback_to_build_date: true
   # - git-authors

docs/requirements.txt

@@ -6,6 +6,7 @@ mkdocs-material==8.5.3
 mkdocs-material-extensions==1.0.3
 mkdocs-mermaid-plugin==0.1.1
 mkdocs-minify-plugin==0.5.0
+mkdocs-open-in-new-tab
 mkdocs-pdf-export-plugin==0.5.10
 mkdocs-table-reader-plugin==1.1.0
 mkdocs-enumerate-headings-plugin==0.5.0

docs/src/01-introduction/images/cp-deploy-current-state.drawio

@@ -1 +1 @@
-<mxfile host="Electron" modified="2023-05-12T09:41:19.543Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/15.8.7 Chrome/91.0.4472.164 Electron/13.6.2 Safari/537.36" etag="s1A4hsxKZTu-uKLCUU1W" version="15.8.7" type="device"><diagram id="2mgyJ-_zdfh3gZ3U018M" name="Page-1">7Zxbc9o6EIB/TWZ6HpLxDQyPXHNok8KETtP0paPYwqixLY4sE+ivP5ItjLGUhIRgXIgfgrTIF+231u5KImdmJ1hcEjCbXmMX+meG5i7OzO6ZYehN02QfXLJMJY2mkQo8glzRaC0Yoz9QCDUhjZELo42GFGOfotmm0MFhCB26IQOE4MfNZhPsb951BjwoCcYO8GXpLXLpVPTCsNfyfyHypqs76/Vm+k0AVo1FT6IpcPFjTmT2zswOwZimpWDRgT5X3kov6Xn9J77NHozAkG5zwmgw710170bNX82eM9SDhz/45/nq4ebAj0WPB+GEgIiS2KExgeLZ6XKlkMcponA8Aw6vPzLoZ2Z7SgOf1XRWBD7yQlb24YQ9VXsOCUVMmy0hppi3nyDf72Afk+SSpqbV2cHlOKQ5eT85hFyYhs7byV0X2uC3g4ucSKjiEuIAUrJkTcS3pui4MMtmXdQf15CblpBN84CbQgiEYXnZpde6ZwWh/teg0CUUwxkMx1PENFkChWZTY8dBKTRq21LQ9kbBlCiMKSZ8lCiJgdU9KAPbOjgDU34TOj6OXSYagYdyRiRNazYPyqFuHp6DIXMAhDI/7TGXzF1HHQRce+lfVvW5hu8JK3m81MHBDIdMJVE50KzOgaHVjMNDkwewDg4nyIsJoAiHZZDosOPArsTSD0/CUpGgvIuluBLr0AxMrUwGC2NErn4h8m3W+rbEzv3v9qJ/LnuS1hwgH9z7sj8nOA5d6Aqdv4CkqL0ntVwco7iLzyF1mLYhUUANkOvyJ3sPLudZ1PoMGd1QkKnvC4zsWtoQhR5/JEweIPf1irGqDET9fkOrAiL70IhkR/KV5aqsnz5guTYjxC6r+Rg/pNwmTIGsNfZjpi5IZJdfDjytCvAsRRC9N3iXNduDwRhcfr69vBtM7n7Sa08x8HVGLLMwtFYUQUU8dryDn14rvFiKyEDJpvEObLqTS++z8eO/IEZDz/ny8H1pYJVTuh0zQc8HEVMDKz2Vch4vpYa2SclWTAXsjZIyfGtKlFQzYzvOv5k16S4jguaAsstrgyCxgWJWdQM9FK16mLcOEM3SKdAJWnAjac8gQUwZHF6XPQyaRXC0FqkizIx1NlvJLcEF0TSxOkU8aRm23W4zOQuqoN8GzoOXWGmuySQ5ChZp8Jsw22XO4xuPX7smE6Ckx9lnFwXMs/R9dM/+ovuAc0SRw7oCQojjKJX+cthlAQqZz7mI5t4zobCM7Fnybx//G4rpRF1XRb76vsy3JkdYvZAi6iex1YcNVd6GVBNAJduQLWewg/Y1E6ym476POn+vj3ofbsXwQtdU736pnsuuS9jm49kUKlZzTgxWpvPqwNIbEqzCss+uS3xyiJFZgzYYDY7MJjJ9vtkoGttm3rq9L6Mw5De49SeJOYvBoCxp3QxPHmndrh5SW0bKs76Xgd4Mxy1ZOob+5DwAIQty3JPnXcweq8BbHtd7CxZzp5NlT6/snxq6bKHmtYm/ub+dGHLqfzP8wmdo+JT0EQa9r6dWjHqr8MLJyUqeWscHUcQn106cnGUUyKmmqrUyI+CaDG5j/nPH+Lcmx79f++Mjs4NMh29+gw8/4VqTg95ht88En4ad8T8nD6yYplQAmBzSjjChj5gsTp5WzaocLTkglXbV7TrUyoHTxi3EGnEXUHBsBrLzrEN92yXjvRnIairsBXoDpjLvib1kpwaxmLxUAOILe2cFxHYcoRBGfBdnK6Y4+MCpGrQrgNPYCuctoFGS5bQGw9lfvLnjnTgWp/8qwFGxKze3lfodfG/dkrBDdvGxqLK4bIo9HAK/t5a214bBya3bXOFkOZWbw29I6VLYA2BDxaaxwAWiP/jpFzVRu8t9012IKyeV5aoSMo3mTuLVu6TasDPB+tSktnFubv05W03exmK3tLcVK66+Z62NQJ+Nm/N8I7XpiFNHGPG9v9lu2eJoU1zHjXBMHCjOytvDSxcqbqelgHiQShdKLDnrzw7GLWfYreQsseXMyf9oAC4cOOMPPyLYjR1eugYRh3lco1b2xr85I6+pNgCUO2rJCZ7itwS7DlyKvCS1m6tua3RsVmHvahWW4icmJVuFIstLgY1b11cnD6yY2B0emK1I7FJggzCiIHSSgflT93u6pbt7b6SFTiv9vLi4OLbpt9djtXSralif3ON9jUNEMUmWGk8cWzGlqwA2RUon/B32vA9mcvpWAWaK9E38nCJ2Ef2AJm/B2Cc0Vl3/34w0i1n/9xGz9z8=</diagram></mxfile>
+<mxfile host="Electron" modified="2023-10-24T07:05:05.318Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/15.8.7 Chrome/91.0.4472.164 Electron/13.6.2 Safari/537.36" etag="kslzDYz50Jf4t7ObbGln" version="15.8.7" type="device"><diagram id="2mgyJ-_zdfh3gZ3U018M" name="Page-1">7Zxbc9o4FIB/TWa6D8n4BoZHMJClTQoTOk3Tl45iC6PGtlhZJtBfv5ItjLGUhIQALsQPwTrIt/Md61wkcmY64fySgOnkGnswODM0b35mds4MQ2+aJvvgkkUmaTbtTOAT5IlOK8EI/YFCqAlpgjwYr3WkGAcUTdeFLo4i6NI1GSAEP653G+Ng/apT4ENJMHJBIEtvkUcnmbRh2Cv5vxD5k+WV9Xoz+yYEy87iSeIJ8PBjQWR2z0yHYEyzvXDuwIArb6mX7LjeE9/mN0ZgRDc5YNifda+ad8Pmr2bXHejhwx/883x5czMQJOKJ+9GYgJiSxKUJgeLe6WKpkMcJonA0BS5vPzLoZ2Z7QsOAtXS2CwLkR2w/gGN2V+0ZJBQxbbaEmGLef4yCwMEBJukpTU2rs43LcUQL8l66CbkwDZ33kx9daINfDs4LIqGKS4hDSMmCdRHfmuLBl2ZZF+3HFeSmJWSTIuCmEAJhWH5+6pXu2Y5Q/2tQ6BKKwRRGowlimtwDhWZTY9tBKTRqm1LQdkbBlCiMKCZ8lNgTA6tzUAa2dXAGpvwmOAFOPCYagof9jEia1mwelEPdPDwHQ+YACGV+2mcumbuOOgi59rK/rBlwDd8TtufzPQeHUxwxlcT7gWY5B4ZWMw4PTR7AHByNkZ8QQBGO9kHCYduBXYmlH56EpSJB+SPuxZVYh2ZgavtkMDeG5OoXIt+mrW8L7N7/bs9757Inac0ACsB9IPtzgpPIg57Q+QtIytp7UsvlMYq7+AJSl2kbEgXUEHkev7P34HKeR63PkNENBZn6rsDIrqUNUeTzW8LkAXJfrxir9oGo12toVUBkHxqR7Ei+slyVPWcAWK7NCLHTagHGDxm3MVMg642DhKkLEtnl7weeVgV4liKI3hm8y5rtw3AELj/fXt71x3c/6bWvGPicIcssDK0Vx1ARjx3v4KfXSi+WIjJQsmm8A5vO+NL/bPz4L0zQwHe/PHxfGFjllG5HTNANQMzUwPaeSjmPl1JDW6dkK0oBO6OkDN+aEiVVZWzL+ptZk64yJGgGKDu91g9TGyhnVTfQR/HyCYvWAeJpVgIdozk3kvYUEsSUweF12M2gaQyHK5EqwsxZ59VKbgkeiCep1SniScuw7XabyVlQBYM2cB/81EoLXcbpVrJIg1+E2S5zHt94/NoxmQClT5x/dlDIPEsvQPfsL7oPOUcUu+xRQARxEmfSXy47LUAR8zkX8cx/JhSWkT1L/u3jf0NRTtR1VeSr78p8a3KE1Y0ookEaW33YUOVtSFUA2rMN2XIG229fM8GyHPd96Py9Pup9uJXDC11Tvft79Vx2XcI2G00nUDGbc2Kwcp1XB5bekGCVpn22neKTQ4zcGrT+sH9kNpHr881G0dg089btXRmFIb/BrT9pzFkOBmVJ62YgC0cwGJ+HIGIu0Tt54HW7esBtGTjPCV/GfTMYtT54P8u7nFtWgbc86nfnLCLPSmlPz/ufGrp8Gue1ZQFzd+s05MLAzeALr9/wgvURhsSvp1aOiavwwsmpTJGaE4A45qW3EydnGSVyqkK2ts/4uCaDW6uObhkd1+To+GtvdGR2kOvwzW/w4cuxNTkkHnR6TPBp4Iz+OXlg5SSmAsDkkHaICX3EZH7ytGpW5WjJAam05m7boVYOnNYuIWaQO4CCYzOQrWsS9U0nlHdmIMtC2Qv0+kxl/hMrzU4NYjl5qQDEF1bWCojtJEYRjPkaz1ZCcfiBUzVoVwCnsRHOW0DjNMtp9QfTv3jpxztxLJf/KsBRsWa3sND6HXxv3ZKwQ3bykWiyuGyCfRyBoLuStleGwcmt+lzhdLKVm8NvSOlC2ANgQ8W6scA5oj/44Rc10borfNOZizOnjcWyETGNFg7izbu02bBzwerQtLV2bGF2Op9r3sRiN7S3JSuuvmetjcCAjZuzYie16YhDhxjxlcH5WtryaFOe5Y1xQlwojiraw0snKi+2pYD4kEonSi05f54tjFvOsFvpUWJBmlv8SQGcu3DKb35IsJe4fO8axBzmcY1a+Rv/5oy8ploesN9RS07wFL802HbgUuQlmd1cdVrDY7MKe1ursBQ/QNmzVSiyvAzYqHV9dfLAyond4YHZisQuA9aPYgoiNx2YP3W+Zwu+O/dGtuO0ss+Li4tjK7+9HqulW1XD+uQK8GscIYpJOtV44tjKKV0FsClSOuHvsO9/MJPTtwowU6Rv4scWiYfoBzR5CcYuobHm6r9qZFnM6n+TmN3/AQ==</diagram></mxfile>

docs/src/10-use-deployer/1-overview/overview.md

@@ -4,24 +4,19 @@
 There are 3 main steps you need to perform to provision an OpenShift cluster with the desired Cloud Pak(s):
 
 1. [Install the Cloud Pak Deployer](../../../05-install/install)
-2. [Configure the environment you want to deploy](../../../10-use-deployer/2-configure/configure)
-3. [Run the Cloud Pak Deployer to create the cluster and install the Cloud Pak](../../../10-use-deployer/3-run/run)
+2. [Run the Cloud Pak Deployer to create the cluster and install the Cloud Pak](../../../10-use-deployer/3-run/run)
 
 ## What will I need?
-To complete the deployment, you will need the following. Details will be provided when you need them.
+To complete the deployment, you will or may need the following. Details will be provided when you need them.
 
 * Your Cloud Pak entitlement key to pull images from the IBM Container Registry
 * IBM Cloud VPC: An IBM Cloud API key that allows you to provision infrastructure
 * vSphere: A vSphere user and password which has infrastructure create permissions
 * AWS ROSA: AWS IAM credentials (access key and secret access key), a ROSA login token and optionally a temporary security token
 * AWS Self-managed: AWS IAM credentials (access key and secret access key) and optionally a temporary security token
+* Azure: Azure service principal with the correct permissions
 * Existing OpenShift: Cluster admin login credentials of the OpenShift cluster
 
-## Other "deployment" activities
-There are a few activities that are somewhat related to deployment of the OpenShift cluster and/or Cloud Paks. These can also be performed through the deployer.
-
-### Post-run configuration and secret retrieval
-
 ### Executing commands on the OpenShift cluster
 The server on which you run the Cloud Pak Deployer may not have the necessary clients to interact with the cloud infrastructure, OpenShift, or the installed Cloud Pak. You can run commands using the same container image that runs the deployment of OpenShift and the Cloud Paks through the command line: [Open a command line](7-command/command)