update readme

Author: davidstacyibm

README.md

@@ -1,40 +1,70 @@
-# Notice
+# Techzone Deployer for the Maximo Application Suite
 
-This repo will be deprecated in favor of a cli driven pipeline at https://github.com/cloud-native-toolkit/deployer-mas-cli
+This repository contains a Tekton pipelines to deploy Maximo using [mas-ansible](https://ibm-mas.github.io/ansible-devops/).
 
+## Pre-requisites
 
+### Deployer Cluster
 
-# Techzone Deployer for the Maximo Operator
+An IBM Technology Zone `deployer` cluster is assumed to be configured with an appropriate Red Hat OpenShift version for the Maximo version you wish to deploy, with appropriate sizing. Refer to [Maximo Product Documentation](https://www.ibm.com/docs/en/mas-cd/continuous-delivery?topic=planning) for more information.
 
-This repository contains a Tekton pipelines to deploy the [Maximo Operator](https://github.com/cloud-native-toolkit/operator-masauto) that packages [mas-ansible](https://ibm-mas.github.io/ansible-devops/).
+A deployer cluster can be created by installing the Deployer Operator from TechZone
 
-## Pre-requisites
 
-An IBM Technology Zone `deployer` cluster is assumed to be configured with an appropriate Red Hat OpenShift version for the Maximo version you wish to deploy, with appropriate sizing. Refer to [Maximo Product Documentation](https://www.ibm.com/docs/en/mas-cd/continuous-delivery?topic=planning) for more information.
+### Entitlement key
 
-A `deployer` cluster is configured with the following items:
+If deploying on TechZone the entitlement key is provided from the TechZone Secrets Repo.  If deploying in a non-techzone cluster you will need to provide an entitlement key for the pipelinerun.
 
-- ExternalSecrets operator deployed with a ClusterSecretStore configured. The remote ExternalSecrets secret store must include an IBM Entitlement Key.
-- Techzone Deployer Tekton tasks deployed ([deploy YAML](https://github.com/cloud-native-toolkit/deployer-tekton-tasks/blob/main/argocd.yaml)).
-- OpenShift GitOps configured with [One Touch Provisioning ArgoCD instance](https://github.com/one-touch-provisioning/otp-gitops), and any relevant RBAC rules.
-- OpenShift Pipelines operator deployed.
-- deployer pipelines tasks and cluster tasks
+Documentation for obtaining an entitlement key here: https://www.ibm.com/docs/en/cloud-paks/1.0?topic=clusters-obtaining-your-entitlement-key
 
 
-## Pipelines organisation
+### Maximo License
+
+To activate Maximo you will need a valid license key which is a text file that contains software authorizations and entitlements.  This pipeline in order to run automatically will need this file to be base64 encoded and saved in a kubernetes secret.
+
+1. save the license file to a file locally such as license.dat.
+2. Use a tool to base64 encode the file such as "
+
+```
+cat license.dat | base64 > license.dat.b64
+```
+
+3. copy the output into an OpenShift secret in the default namespace
+
+```
+oc create secret generic maximolicense --from-file=licensefile=license.dat.b64 -n default
+```
+
+remember the name of the secret for the pipeline run.  ( in the example above "maximolicense" is the name)
 
-Maximo is deployed with a Tekton Pipeline that is defined in maximo-pipeline.yaml
 
+## Pipelines organisation
+
+Maximo is deployed with a Tekton Pipeline that is defined in pipeline.yaml
 
-## Tasks
+the pipeline runs the MAS DevOps playbooks and can be modified or extended using other roles and playbooks.
 
-Currently uses oc client, git clone, and helm-update-from-source from tekton hub
+Consult the documentation for MAS DevOps [here](https://ibm-mas.github.io/ansible-devops/)
 
 ## Usage
 
+
 ###
+switch to version directory of choice and run these commands
 ```
-oc apply -f maximo-pipeline.yaml
-
-tkn pipeline start mas-core-deploy --pod-template pod-template.yaml -w name=shared-workspace,volumeClaimTemplateFile=workspace-template.yaml
+oc apply -f pipeline.yaml
+oc create -f pipeline-run.yaml
 ```
+
+# Known Issues
+
+## Time to install
+
+In testing we have seen the pipeline take from 2-6 hours to progress from installation of operators to active instances of the software.  please be patient.
+
+The pipeline is fully idempotent and can be restarted as needed.
+
+
+## TLS certs
+
+the pipeline looks for a lets-encrypt cert previously generated by upstream automation and if found uses this cert for maximo public routes.  This cert may not have all maximo paths enabled by default.  If you encounter a non-trusted certificate you may have to open the path in a separate browser window and accept the cert.