CLD 545: EA1 Documentation fixes (#16)

* CLD-545: EA1 document changes commit

* CLD-545: EA1 document changes commit

* CLD-545: Spell Check Correction

Co-authored-by: Sumanth Ravipati <[email protected]>

Author: sumanthravipati

README.md

@@ -1,6 +1,5 @@
 # MarkLogic Kubernetes Helm Chart
 
-- [MarkLogic Kubernetes Helm Chart](#marklogic-kubernetes-helm-chart)
 - [Introduction](#introduction)
 - [Prerequisites](#prerequisites)
   - [Set up the required tools](#set-up-the-required-tools)
@@ -12,8 +11,8 @@
       - [Install eksctl](#install-eksctl)
       - [Using eksctl to provision Kubernetes cluster on EKS](#using-eksctl-to-provision-kubernetes-cluster-on-eks)
       - [Suggestions for Naming](#suggestions-for-naming)
-- [Install Marklogic Helm Chart](#install-marklogic-helm-chart)
-  - [Add Marklogic Repo](#add-marklogic-repo)
+- [Install MarkLogic Helm Chart](#install-marklogic-helm-chart)
+  - [Add MarkLogic Repo](#add-marklogic-repo)
   - [Installing the Chart](#installing-the-chart)
   - [Configuration Options](#configuration-options)
     - [--values](#--values)
@@ -31,9 +30,13 @@
 
 # Introduction
 
-MarkLogic Server is a multi-model database that has both NoSQL and trusted enterprise data management capabilities. It is the most secure multi-model database.
-
-This custom Helm Chart deploys MarkLogic Server on Kubernetes using Helm.
+This tutorial describes how to set up Kubernetes development environment with AWS EKS and MarkLogic Server. It covers these tasks:
+- Set up the prerequisites necessary for setting up MarkLogic Server in Kubernetes
+- How to setup Kubernetes cluster and install MarkLogic Server on Minikube
+- How to setup Kubernetes cluster and install MarkLogic Server on AWS EKS using eksctl
+- Access the MarkLogic Server cluster
+- How to clean up your environment
+- List of parameters used for configuration
 
 # Prerequisites
 
@@ -106,11 +109,11 @@ eksctl create cluster \
 * KUBERNETES_VERSION: For now, we only support the latest version of Kubernetes in EKS, which is 1.21.
 * NODEGROUP_NAME: Choose a distinctive node group name.
 * NODE_TYPE: The recommendation from our performance team is to use the r5.large node type for development purposes.
-* NUMBER_OF_NODES: Total number of nodes running not only Marklogic database, but also nodes running other applications.
+* NUMBER_OF_NODES: Total number of nodes running not only MarkLogic database, but also nodes running other applications.
 
-# Install Marklogic Helm Chart
+# Install MarkLogic Helm Chart
 
-## Add Marklogic Repo
+## Add MarkLogic Repo
 
 If you haven’t already, add the MarkLogic official repo to Helm using this command:
 
@@ -297,7 +300,7 @@ To use transactional functionality with MarkLogic, you have to set up Ingress an
 Use this Helm command to uninstall the chart:
 
 ```
-helm delete my-release
+helm uninstall my-release
 ```
 
 The output will look like this:
@@ -329,6 +332,7 @@ This table describes the list of available parameters for Helm Chart.
 | `resources.limits`                   | The resource limits for MarkLogic container                                                                    | `{}`                                 |
 | `resources.requests`                 | The resource requests for MarkLogic container                                                                  | `{}`                                 |
 | `nameOverride`                       | String to override the app name                                                                                | `""`                                 |
+| `fullnameOverride`                   | String to completely replace the generated name                                                                | `""`                                 |
 | `auth.adminUsername`                 | Username for default MarkLogic Administrator                                                                   | `admin`                              |
 | `auth.adminPassword`                 | Password for default MarkLogic Administrator                                                                   | `admin`                              |
 | `affinity`                           | Affinity property for pod assignment                                                                           | `{}`                                 |

docs/Local_Development_Tutorial.md

@@ -1,6 +1,5 @@
 # Local Development Tutorial: Getting Started with MarkLogic in Kubernetes
 
-# Table of contents
 * [Introduction](#Introduction)
 * [Prerequisites](##Prerequisites)
 * [Procedure](#Procedure)
@@ -21,13 +20,12 @@ This tutorial describes how to set up local Kubernetes development environment w
 
 
 ## Prerequisites
-The following steps assume you are running this tutorial from a desktop environment. Mobile environments will likely experience problems and may not work.
-- [Docker](https://docs.docker.com/engine/install/): Subscribe to Docker Hub and pulldown the latest image from: https://hub.docker.com/_/marklogic
+The following steps assume you are running this tutorial from a desktop environment.
+- [Docker](https://docs.docker.com/engine/install/): Pull the latest MarkLogic Server image from: https://hub.docker.com/r/marklogicdb/marklogic-db
   ```sh
-  # Something similar to this, with the latest version tag, which can be found on the dockerhub link above
-  docker pull store/marklogicdb/marklogic-server:10.0-9-centos-1.0.0-ea4 
+  docker pull marklogicdb/marklogic-db:latest
   ```
-- [KubeCTL](https://kubernetes.io/docs/tasks/tools/):  Download and install this tool to assist with debugging in a Kubernetes environment. 
+- [Kubectl](https://kubernetes.io/docs/tasks/tools/):  Download and install this tool to assist with debugging in a Kubernetes environment.
 - [Helm](https://helm.sh/docs/intro/install/):  Clone or download the chart repository: https://github.com/marklogic/marklogic-kubernetes
 - [Minikube](https://k8s-docs.netlify.app/en/docs/tasks/tools/install-minikube/): Download the Minikube Kubernetes environment, which will host the MarkLogic Server applications.
 - Browser: The latest version of a supported web browser. See the list here: [Web Browser](https://developer.marklogic.com/products/support-matrix/) 
@@ -53,17 +51,14 @@ NAME       STATUS   ROLES                  AGE   VERSION
 minikube   Ready    control-plane,master   1d    v1.23.3
 ```
 
- To enable addons run the follow Minikube command for ingress:     
- `minikube addons enable ingress`  
 ##  Installing a Single MarkLogic Host to Minikube
-- Push the image used for MarkLogic Server to the VM:   
-`minikube image load store/marklogicdb/marklogic-server:10.0-9-centos-1.0.0-ea4`  
-  The image ID used in the example is `store/marklogicdb/marklogic-server:10.0-9-centos-1.0.0-ea4`, which may not be the latest image. To find the latest ID go to https://hub.docker.com/_/marklogic  
+- Push the image used for MarkLogic Server to the Minikube:
+`minikube image load marklogicdb/marklogic-db:latest`
 - Add the helm repository
   `helm repo add marklogic https://marklogic.github.io/marklogic-kubernetes/`  
   Additionally create a `values.yaml` file for your installation, like the one found in the repository under `/charts`: https://marklogic.github.io/marklogic-kubernetes/. The `values.yaml` file controls configuration for MarkLogic Server running in kubernetes. 
-  Run `helm install RELEASE_NAME marklogic/marklogic --version=1.0.0-ea1 -f values.yaml` where the `RELEASE_NAME` can be any name you want to use to identify this deployment.    
-  For example: `helm install marklogic-local-dev-env marklogic/marklogic --version=1.0.0-ea1 -f values.yaml`
+  Run `helm install RELEASE_NAME marklogic/marklogic --version=1.0.0-ea1 --values values.yaml` where the `RELEASE_NAME` can be any name you want to use to identify this deployment.
+  For example: `helm install marklogic-local-dev-env marklogic/marklogic --version=1.0.0-ea1 --values values.yaml`
 ## Installing Multiple MarkLogic Hosts to Minikube
 To create a MarkLogic cluster in Minikube, change the `replicaCount` in the `values.yaml` file to 3, or any other odd number to avoid the [split brain problem](https://help.marklogic.com/Knowledgebase/Article/View/119/0/start-up-quorum-and-forest-level-failover). Then follow the procedure outlined in the [Installing a Single MarkLogic Host to Minikube](##Installing-a-Single-MarkLogic-Host-to-Minikube) section.