Merge pull request #139 from stakater/content-updates

Content updates

README.md

@@ -48,10 +48,10 @@ Finally serve the docs using the built-in web server which is based on Python ht
 $ mkdocs serve
 ```
 
-or 
+or
 
 ```bash
-$ python3 -m mkdocs serve 
+$ python3 -m mkdocs serve
 ```
 
 ### QA Checks

content/about/cloud-providers/aws.md

@@ -1,13 +1,13 @@
 # AWS
 
-An AWS account is needed to create and manage cluster on AWS. The following criteria must be met
+An AWS account is needed to create and manage cluster on AWS. The following criteria must be met:
 
 - An account on AWS.
 - A Stakater user (ask Stakater team for the email to use for this user) with admin privileges on a separate project (Recommended). See the [required permissions](https://docs.openshift.com/container-platform/4.9/installing/installing_aws/installing-aws-account.html#installation-aws-permissions_installing-aws-account) for AWS if you do not want to grant admin privilege.
 - Resource limits must be applied on the account and the following resources must be allowed to be created.
 
   |Type        | Limit |
-    |------------|------------|
+  |------------|------------|
   | Virtual Machines | Varies. The limit should be 12 initially. (Initial deployment is 3 master + 3 infra + 3 worker)|
   | Regional vCPUs | The limit should be A x B x 2 , where A = no. of VMS (worker + infra + master), B = vCPUs per VM) |
   | Elastic IPs (EIPs) | 5 |
@@ -45,7 +45,3 @@ SAAP offers the following worker node types and sizes on AWS:
 ### Autoscaling
 
 Node autoscaling is available on AWS. You can configure the autoscaler option to automatically scale the number of machines in a cluster.
-
-## Network usage
-
-## Cloud network configuration

content/about/cloud-providers/azure.md

@@ -1,8 +1,8 @@
 # Azure
 
-An azure subscription is needed to create and manage cluster on azure. The following criteria must be met
+An Azure subscription is needed to create and manage cluster on Azure. The following criteria must be met:
 
-- An azure subscription.
+- An Azure subscription.
 - A Stakater user (ask Stakater team for the email to use for this user) with privileges to create an application in Azure AD (Recommended). [Create a Service Principal](https://docs.openshift.com/container-platform/4.9/installing/installing_azure/installing-azure-account.html#installation-azure-service-principal_installing-azure-account) to be used by SAAP installer if you do not want to give permissions to Azure AD.
 - Resource limits must be applied on the subscription and the following resources must be allowed to be created.
 
@@ -19,16 +19,6 @@ An azure subscription is needed to create and manage cluster on azure. The follo
   | Machine Specifications | 6 machines of 8x32x120G |
   | Region | Region will be identified by the customer |
 
-## Instance Types
-
-SAAP offers the following worker node types and sizes on Azure:
-
-### General Purpose
-
-### Memory Optimized
-
-### Compute Optimized
-
-### Autoscaling
+## Autoscaling
 
 Node autoscaling is available on Azure. You can configure the autoscaler option to automatically scale the number of machines in a cluster.

content/about/cloud-providers/binero.md

@@ -1,6 +1,6 @@
 # Binero
 
-A OpenStack account is needed to create and manage cluster on Binero OpenStack. The following criteria must be met
+A OpenStack account is needed to create and manage cluster on Binero OpenStack. The following criteria must be met:
 
 - An account on Binero.
 - A Stakater user (ask Stakater team for the email to use for this user) with admin privileges.
@@ -20,22 +20,6 @@ A OpenStack account is needed to create and manage cluster on Binero OpenStack.
   | Ports  | 5000 |
   | Routers | 10 |
 
-## Instance Types
-
-SAAP offers the following worker node types and sizes on Binero:
-
-### General Purpose
-
-- ...
-
-### Memory Optimized
-
-- ...
-
-### Compute Optimized
-
-- ..
-
 ## Network usage
 
 - 5000 GB included free per month

content/about/cloud-providers/gcp.md

@@ -1,13 +1,13 @@
 # GCP
 
-A GCP account is needed to create and manage cluster on GCP. The following criteria must be met
+A GCP account is needed to create and manage cluster on GCP. The following criteria must be met:
 
 - An account on GCP.
 - A Stakater user (ask Stakater team for the email to use for this user) with admin privileges on a separate project (Recommended). See the [required permissions](https://docs.openshift.com/container-platform/4.9/installing/installing_gcp/installing-gcp-account.html#installation-gcp-permissions_installing-gcp-account) for GCP if you do not want to grant admin privilege.
 - Resource limits must be applied on the account and the following resources must be allowed to be created.
 
   |Type        | Limit |
-    |------------|------------|
+  |------------|------------|
   | Virtual Machines | Varies. The limit should be 12 initially. (Initial deployment is 3 master + 3 infra + 3 worker)|
   | Regional vCPUs | The limit should be A x B x 2 , where A = no. of VMS (worker + infra + master), B = vCPUs per VM) |
   | In-use global IP addresses | 4 |
@@ -23,16 +23,6 @@ A GCP account is needed to create and manage cluster on GCP. The following crite
   | Machine Specifications | 9 machines of 8x32x120G |
   | Region | Region will be identified by the customer |
 
-## Instance Types
-
-SAAP offers the following worker node types and sizes on GCP:
-
-### General Purpose
-
-### Memory Optimized
-
-### Compute Optimized
-
-### Autoscaling
+## Autoscaling
 
 Node autoscaling is available on GCP. You can configure the autoscaler option to automatically scale the number of machines in a cluster.

content/about/cloud-providers/overview.md

@@ -1,11 +1,11 @@
 # Overview
 
-Stakater App Agility Platform (SAAP) is currently supported on following clouds:
+Stakater App Agility Platform (SAAP) is currently supported on the following clouds:
 
 * [AWS](./aws.md)
 * [Azure](./azure.md)
 * [GCP](./gcp.md)
 * [Binero](./binero.md)
-* [UpCloud](./upcloud.md)
+* [Exoscale](./exoscale.md)
 
-Just drop us an email at [`[email protected]`](mailto:[email protected]) if you would like us to support another cloud.
+Just drop us an email at [`[email protected]`](mailto:[email protected]) if you would like us to support another cloud. Visit our [Partnership page](https://www.stakater.com/partnership) to apply for becoming a cloud partner.

content/about/service-definition/account-management.md

@@ -11,7 +11,3 @@ Billing for SAAP is on a monthly basis, or yearly basis with discounts.
 ## Cloud Providers
 
 SAAP is available as a managed platform on the cloud providers listed on the [cloud providers overview](../cloud-providers/overview.md).
-
-## Cluster Creation
-
-The administrative section contains information about [cluster creation](../../for-administrators/create-your-cluster.md).

content/about/service-definition/security.md

@@ -2,7 +2,7 @@
 
 ## Authentication Provider
 
-Authentication for the cluster is configured as part of the [cluster creation process](../../for-administrators/create-your-cluster.md). SAAP is not an identity provider, and all access to the cluster must be managed by the customer as part of their integrated solution. Creating multiple identity providers at the same time is supported. The following identity providers are supported:
+Authentication for the cluster is configured as part of the cluster creation process. SAAP is not an identity provider, and all access to the cluster must be managed by the customer as part of their integrated solution. Creating multiple identity providers at the same time is supported. The following identity providers are supported:
 
 - GitHub or GitHub Enterprise OAuth
 - GitLab OAuth

content/for-administrators/networking/external-dns.md

@@ -116,7 +116,7 @@ metadata:
 spec:
   releaseName: external-dns
   chart:
-    repository: https://kubernetes-charts.storage.googleapis.com 
+    repository: https://kubernetes-charts.storage.googleapis.com
     name: external-dns
     version: 2.4.2
   values:

content/for-administrators/plan-your-environment/sizing.md

@@ -1,5 +1,5 @@
 # Sizing
-<!---
+
 > Glossary:
 >
 > **User workloads:** User applications (e-commerce frontend, backend APIs, etc.)
@@ -207,4 +207,3 @@ No additional Floating IPs/Public IPs are required.
 #### For OpenStack
 
 `2 x Floating IPs` are required (for cluster API and cluster dashboard).
--->

content/for-administrators/secure-your-cluster/secure-routes.md

@@ -62,7 +62,7 @@ metadata:
   namespace: route-demo
   annotations:
     haproxy.router.openshift.io/ip_whitelist: 8.8.8.8 8.8.8.9 # Will whitelist this route for the 8.8.8.8 and 8.8.8.9
-    haproxy.router.openshift.io/timeout: 5000ms # Sets a server-side timeout for the route for 5000ms   
+    haproxy.router.openshift.io/timeout: 5000ms # Sets a server-side timeout for the route for 5000ms
 spec:
 # In case you omit `host` field OpenShift will generate a hostname for you as <name>-<namespace-name>.DOMAIN_NAME
   host: hello-world-app.apps.<CLUSTER_NAME>.<CLUSTER_ID>.kubeapp.cloud

content/for-cisos/backup-restore/velero-cli.md

@@ -10,7 +10,7 @@ Note: Below commands are Linux specific
 1. To unzip the download file:
 
     ```sh
-    tar -xzf velero-<VERSION>-<PLATFORM>.tar.gz 
+    tar -xzf velero-<VERSION>-<PLATFORM>.tar.gz
     cd velero-<VERSION>-<PLATFORM>/
     ```
 

content/for-delivery-engineers/how-to-guides/configure-repository-secret/configure-repository-secret.md

@@ -94,4 +94,6 @@ If you see the following error. Check `argocd-ssh-known-hosts-cm` config map in
 ![`ArgoCD-repo-connection-ssh-issue`](../images/ArgoCD-repo-connection-ssh-issue.png)
 
 Some known hosts public keys might be missing in `argocd-ssh-known-hosts-cm` for older ArgoCD versions, Find full list of public keys against repository server [here](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#ssh-known-host-public-keys).
-> Note: If the error persists, contact **Stakater Support** to review it.
+
+!!! note
+    If the error persists, contact **Stakater Support** to review it.

content/for-delivery-engineers/how-to-guides/use-a-cluster-task-in-pipeline/use-a-clustertask-in-pipeline.md

@@ -192,14 +192,6 @@ If you want to add this clustertask as `defaultTask` in [`stakater-tekton-chart`
 
 1. Log in to ArgoCD and open the application corresponding to this environment. You can find the application name in `tenant/argocd-apps/env/app-name-env.yaml` or `tenant/argocd-apps/env/tekton-pipeline-env.yaml`.
 
-    `Image`
-
 1. Check if your pipeline resource is updated by clicking on the pipeline resource.
 
-    `Image`
-
 1. Trigger the pipeline by making a change in your code repository and see if your task works as expected for pull request opened, updated and merged scenarios.
-
-    `Image`
-
-### Possible Issues

content/for-delivery-engineers/tutorials/03-deploy-demo-app/deploy-demo-app.md

@@ -204,7 +204,7 @@ If your application contains dependency charts run the following command in depl
     ```sh
     # Generates the chart against values file provided
     # and write the output to application-output.yaml
-    # command info : helm template --help 
+    # command info : helm template --help
     helm template . > application-output.yaml
     ```
 
@@ -245,7 +245,8 @@ Navigate to `apps-gitops-config` repository and add a helm chart in path `gabbar
 
 For Chart.yaml:
 
-> Note: In **Chart.yaml** 'C' is capitalized.
+!!! note
+    In **Chart.yaml** 'C' is capitalized.
 
 ```yaml
 # <tenant-name>/<app-name>/dev/Chart.yaml

content/for-delivery-engineers/tutorials/04-add-tekton-pipeline-to-demo-app/add-pipeline.md

@@ -282,7 +282,8 @@ stakater-tekton-chart:
 
 - Here, we are using the [default triggers](https://github.com/stakater/stakater-tekton-chart/blob/main/stakater-tekton-chart/default-config/triggers.yaml). You will need to [deploy your own trigger bindings](https://github.com/stakater/stakater-tekton-chart/blob/085d1ba52175294a21255a27561ac0ebe8621e85/stakater-tekton-chart/values.yaml#L96) via values.yaml file, or you can use MTO templates. Then add the deployed trigger bindings as ref to the triggers in the above **values.yaml** file.
 
-> Note: The reference to the trigger binding will need to be added in; (pipeline-charts.eventListener.trigger.bindings.ref).
+!!! note
+    The reference to the trigger binding will need to be added in; (pipeline-charts.eventListener.trigger.bindings.ref).
 
 ## 4. ArgoCD Application for Pipeline and its Resources
 

content/for-developers/explanation/plan-your-deployment.md

@@ -119,7 +119,7 @@ Setup a CI/CD pipeline to for Continuous Integration and Continuous Deployments.
 Users can expose your application in/out the cluster using Services, Ingresses, Routes.
 
 - Users can create two types of services for external networking: NodePort, LoadBalancer.
-- Users can create Routes to exposes a service at a host name, such as www.example.com, so that external clients can reach it by name.
+- Users can create Routes to exposes a service at a host name, such as `www.example.com`, so that external clients can reach it by name.
 - Users can create Ingresses on a host name which is being watched by ingress controller and creates one or more routes to satisfy the conditions of the ingress object.
 
 OpenShift has a built-in `HAProxy` ingress controller that allows users to expose services externally with routes and ingress.