DEPLOY-276: Updated Readme to address review changes, updated requirements and notes for AWS usage posibility

README.md

@@ -36,21 +36,21 @@ Build and start Alfresco Content Services Community using docker-compose or Kube
 
 ### Kubernetes Instructions:
 #### Prerequisite: 
-* A minikube k8s cluster up and ready
+* A minikube/aws k8s cluster up and ready (minimum 5GB memory)
 * Access to docker-internal.alfresco.com and quay.io repositories - Platform Services team is working on getting the images in [Docker Hub](https://hub.docker.com/u/alfresco/) registry.
+* A kubernetes secret (quay-registry-secret) with the above mentioned credentials created in your cluster.
 
 #### Steps
 1. Go to **helm** folder
-2. Run ```helm install alfresco-content-services``` 
+2. Run ```helm dependency update && helm install alfresco-content-services``` 
-3. After deploying the helm chart you will get information for obtaining the URL for alfresco, share and solr.
+3. After deploying the helm chart you will get information for obtaining the URL for repository, share and solr.
 
 #### Notes:
 
-* The images used in the alfresco-content-services/values.yml are images that are build in the 'docker-alfresco' and 'docker-share' subfolders of the project - see the relevant sections below
+* The images used in the alfresco-content-services/values.yml are images that are built in the 'docker-alfresco' and 'docker-share' subfolders of the project - see the relevant sections below.
 * If you don't have access to the docker-internal.alfresco.com and quay.io images, or if you want custom data in your docker images, you can use the 'docker-alfresco' and 'docker-share' folders to customize and build your customized docker images that are used in the docker-compose project. Just make sure you build them in the minikube docker environment and update the alfresco-content-services/values.yml with the tags that you created.
-* You can also change those values on a live env by running ```helm alfresco-content-services --set repository.image.tag="yourTag" --set share.image.tag="yourTag"```
+* You can also change those values when deploying the helm chart by running ```helm alfresco-content-services --set repository.image.tag="yourTag" --set share.image.tag="yourTag"```.
-* Hint: Run  ```eval $(minikube docker-env)``` to switch to your your minikube docker env on osx
+* Hint: Run  ```eval $(minikube docker-env)``` to switch to your minikube docker environment on osx.
-
 
 ## Docker images
 These images are used to build the images used by the docker-compose.yml project to bring up an ACS Community, similar to what the installer did/does.  

helm/alfresco-content-services/requirements.lock

@@ -4,6 +4,6 @@ dependencies:
   version: 0.8.5
 - name: nginx-ingress
   repository: https://kubernetes-charts.storage.googleapis.com
-  version: 0.8.18
+  version: 0.8.21
-digest: sha256:ee2a7ec0ed228940857082137c9fe72ff81fc4a2bdb3ca8315d258066750b714
+digest: sha256:6eae9ef52c9b9be71a85a9223dcb35a5ff43d72044fd0ca47bd91f299f75052a
-generated: 2017-12-15T16:41:34.393214+02:00
+generated: 2017-12-18T10:40:16.035017+02:00

helm/alfresco-content-services/requirements.yaml

@@ -3,6 +3,8 @@ dependencies:
 - name: postgresql
   version: 0.8.5
   repository: https://kubernetes-charts.storage.googleapis.com/
+  condition: postgresql.enabled
 - name: nginx-ingress
-  version: ^0.8.11
+  version: ^0.8.21
-  repository: https://kubernetes-charts.storage.googleapis.com
+  repository: https://kubernetes-charts.storage.googleapis.com
+  condition: nginx-ingress.enabled

helm/alfresco-content-services/templates/NOTES.txt

@@ -1,8 +1,15 @@
-1. Get the application URL by running these commands:
+1. Get the share application URL by running these commands:
 
 IP=$(minikube ip)
 PORT=$(kubectl get services {{ .Release.Name }}-nginx-ingress-controller -o jsonpath={.spec.ports[0].nodePort})
 echo "http://$IP:$PORT/share"
 
-2. To access Alfresco go to /alfresco path with the same base URL
+2. To access Repository go to /alfresco path with the same base URL
-4. To access Solr go to /solr path with the same base URL
+3. To access Solr go to /solr path with the same base URL
+
+4. If you deployed on an AWS cluster you can get the route53 entry for the cluster as follows:
+
+DNSNAME=$(kubectl get services {{ .Release.Name }}-nginx-ingress-controller -o jsonpath={.status.loadBalancer.ingress[0].hostname})
+echo "http://$DNSNAME/share"
+
+5. Note: if you deployed on a different namespace than the default one, then the kubectl commands should also specify the namespace to run in with --namespace

helm/alfresco-content-services/values.yaml

@@ -53,6 +53,9 @@ solr:
     SOLR_CREATE_ALFRESCO_DEFAULTS: alfresco,archive
 
 postgresql:
+  ## If true, install the postgresql chart alongside Alfresco Content Services
+  enabled: true
+
   nameOverride: postgresql-acs
   imageTag: "9.4.12"
 
@@ -62,3 +65,7 @@ postgresql:
 
   persistence:
     enabled: false
+
+nginx-ingress:
+  ## If true, install the nginx-ingress chart alongside Alfresco Content Services
+  enabled: true