Endoc 446-Updates to CR page and remove Helm #487

jyunmitch · 2022-04-14T13:58:57Z

Updates to Custom Resources page and remove Helm mentions

…s.md

jyunmitch · 2022-04-14T14:02:14Z

links failed because of new docs (Operator and env variable) not in this branch but already merged in main

jyunmitch · 2022-04-14T14:04:31Z

vuepress/docs/next/tutorials/curate/ecr-private-images.md

+
+* Build and deploy the updated bundle.
+
+<!-- Supply the following parameters:


I put comment tags around sections and lines that should be removed but wasn't completely sure about. Hope that isn't too confusing.

jyunmitch · 2022-04-14T14:05:01Z

vuepress/docs/next/tutorials/curate/ecr-private-images.md

@@ -61,7 +95,7 @@ operator.imagePullSecrets: [your-secret-name]
 <snip>
 ```

-You can now generate the deployment yaml and deploy it to Kubernetes as usual.
+You can now generate the deployment yaml and deploy it to Kubernetes as usual. -->


another commented section to be removed

vuepress/docs/next/tutorials/devops/external-db.md

Lyd1aCla1r3 · 2022-04-14T20:04:03Z

vuepress/docs/next/docs/consume/custom-resources.md

 # Entando Custom Resources for Kubernetes

 ## Objective

-This is an overview of Entando Kubernetes Custom Resources and their semantics.
+
+This is an overview of Entando Kubernetes Custom Resources and their semantics on the Entando Platform.


semantics seems like a very odd and cryptic word choice

Lyd1aCla1r3 · 2022-04-14T20:04:36Z

vuepress/docs/next/docs/consume/custom-resources.md

@@ -53,8 +59,10 @@ result in the Deployment of one or more Docker images, along with one or more Se

 The Entando Operator itself is also implemented as a Docker Image. You can have a closer look at how it works in the


Lyd1aCla1r3 · 2022-04-14T20:06:09Z

vuepress/docs/next/docs/consume/custom-resources.md

@@ -149,7 +160,8 @@ spec:
     [globally configured TLS Secret](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#tls) 
     for the Operator is absent or has not been created with a wildcard hostname that supports this Keycloak instance's hostname.
 * `spec.replicas` - the number of replicas to be made available on the Deployment of this Keycloak Server.
-* `spec.resourceRequirements` - the minimum and maximum [resource allocations](#the-resourcerequirements-specification) for the Keycloak Server container.                                                               
+
+* `spec.resourceRequirements` - the minimum and maximum [resource allocations](#the-resourcerequirements-specification) for the Keycloak Server container.                                     


is the Keycloak Server a thing? server isn't capitalized i don't think

Lyd1aCla1r3 · 2022-04-14T20:07:01Z

vuepress/docs/next/docs/reference/caching-and-clustering.md

@@ -12,7 +12,7 @@ Microservices clustering that adds functionality to an Entando Application is di

 To scale an Entando Application across multiple nodes, a storage class that supports a `ReadWriteMany` access policy must be created. There are a number of ways to accomplish this, inclusive of dedicated storage providers such as GlusterFS. Cloud Kubernetes providers also offer clustered storage options specific to their implementation, such as Google Cloud File in GKE or Azure Files in AKS.

-Two different storage classes can be used for clustered vs non-clustered storage if the default class doesn't support `ReadWriteMany`. To achieve this, add the following properties to the operator config map in the Helm templates:
+Two different storage classes can be used for clustered vs non-clustered storage if the default class doesn't support `ReadWriteMany`. To achieve this, add the following properties to the operator Config Map:


vs.

ConfigMap

Lyd1aCla1r3 · 2022-04-14T20:08:25Z

vuepress/docs/next/docs/reference/databases.md


-You can achieve this by specifying some properties for the EntandoApp component present in the helm generated file. Look at [this](https://github.com/entando-k8s/entando-helm-quickstart) for more info.
+You can achieve this by specifying some properties for the EntandoApp component present in the entandoapp.yaml file.


YAML files are backticked, right?

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

Lyd1aCla1r3 · 2022-04-14T20:18:44Z

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

 ```
 helm template quickstart ./ > my-clustered-app.yaml
 ```

-11. Add environment variables for your deployed Redis instance to `EntandoApp` in `my-clustered-app.yaml`. The variables to create are:
+11. Add environment variables to the `EntandoApp` in the outcome of the Helm template command generated above (`my-clustered-app.yaml`) for the Redis address and Redis password for your deployed Redis instance. The variables to create are: -->


super confusing run-on sentence. is the original not correct? like "Add address and password environment variables for your deployed Redis instance to EntandoApp in my-clustered-app.yaml, which is the outcome of the Helm template generation."
the command wasn't generated, right? the YAML file was generated ??
the EntandoApp is misleading, like only one exists

this section is commented out, to be deleted

Lyd1aCla1r3 · 2022-04-14T20:19:12Z

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

@@ -191,7 +203,7 @@ spec:
  ingressPath: /entando-de-app
  environmentVariables:
    - name: REDIS_ADDRESS
-      value: [your redis URI. For example redis://localhost:6379]
+      value: YOUR redis URI. For example redis://localhost:6379


Redis

what is a URI?

https://stackoverflow.com/questions/176264/what-is-the-difference-between-a-uri-a-url-and-a-urn/1984225#1984225

Lyd1aCla1r3 · 2022-04-14T20:19:43Z

vuepress/docs/next/tutorials/devops/external-db.md


 ## Prerequisites

-   An environment to install your Entando applicaiton
+-   An environment to install your Entando application


Application

Lyd1aCla1r3 · 2022-04-14T20:20:23Z

vuepress/docs/next/tutorials/devops/external-db.md

-5. Under `environmentVariables` you will need to provide database connection information for two Entando Server databases and one connection for the Entando Component Repository. Example connection information for each of those databases is provided below:
+2. Edit the EntandoApp and EntandoKeycloakServer custom resources.
+3. Set the value for `dbms` to `none` in both resources.
+4. Under `environmentVariables`, you will need to provide database connection information for two Entando Server databases and one connection for the Entando Component Repository. Example connection information for each of those databases is provided below:


Entando Server -> Entando server

nshaw · 2022-04-18T14:00:02Z

vuepress/docs/next/docs/consume/custom-resources.md

 and create the `keycloak-admin-secret` in the operator's namespace as specified in the 
-[external Keycloak instance](../../tutorials/devops/external-id-management.md) tutorial.
+[external database tutorial](../../tutorials/devops/external-id-management.md).


This was actually related to an external Keycloak.

nshaw · 2022-04-18T15:03:35Z

@Lyd1aCla1r3 and @jyunmitch I applied most of the PR feedback but again we're getting into several untouched docs so let's just do the basic for review.

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

nshaw · 2022-04-18T16:41:12Z

vuepress/docs/next/tutorials/devops/external-db.md

 ```

 #### Oracle
 ```
 XXX_URL:                      jdbc:oracle:{driver_type}:@//{DBMS_ADDRESS}:{DBMS_PORT}/{DBMS_SERVICE_NAME}
 XXX_CONNECTON_CHECKER:        org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker
 XXX_EXCEPTION_SORTER:         org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter
-SPRING_JPA_DATABASE_PLATFORM: org.hibernate.dialect.Oracle
+SPRING_JPA_DATABASE_PLATFORM: org.hibernate.dialect.MySQLDialect 


nshaw · 2022-04-18T18:27:34Z

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

@@ -191,7 +203,7 @@ spec:
  ingressPath: /entando-de-app
  environmentVariables:
    - name: REDIS_ADDRESS
-      value: [your redis URI. For example redis://localhost:6379]
+      value: YOUR redis URI. For example redis://localhost:6379


https://stackoverflow.com/questions/176264/what-is-the-difference-between-a-uri-a-url-and-a-urn/1984225#1984225

jyunmitch · 2022-04-18T19:01:44Z

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

 ```

-**The following example pertains to the EntandoApp only, not a complete deployment.** Utilize this as a reference to create your configuration in a complete deployment.
+11. Add environment variables to the `EntandoApp` defition to match your Redis instance. The variables to create are REDIS_ACTIVE, REDIS_ADDRESS (e.g. _redis://localhost:6379_), and REDIS_PASSWORD.


was just about to approve, but was reading through and found typo: definition. Otherwise approved

Lyd1aCla1r3 · 2022-04-18T19:04:55Z

vuepress/docs/next/docs/consume/custom-resources.md

@@ -51,10 +57,12 @@ Entando Custom Resource is created, updated or deleted, the Entando Operator wil
 that will translate that state change into a state change in the actual Kubernetes Cluster. Often, this will
 result in the Deployment of one or more Docker images, along with one or more Services, and sometimes an Ingress. We refer to the Docker Images that implement these run-to-completion Pods as Entando Kubernetes Controllers.

-The Entando Operator itself is also implemented as a Docker Image. You can have a closer look at how it works in the
+The Entando Operator itself is also implemented as a Docker image. You can have a closer look at how it works in the


"have a closer look" sounds awkward. minor. sorry.

Lyd1aCla1r3 · 2022-04-18T19:06:01Z

vuepress/docs/next/docs/consume/custom-resources.md

@@ -256,6 +260,8 @@ spec:
 * `spec.replicas` - the number of replicas to be made available on the Deployment of this Entando App.                                  
 * `spec.resourceRequirements` - the minimum and maximum [resource allocation](#the-resourcerequirements-specification) for the Entando App Engine container.                                     
 * `spec.ecrGitSshSecretName` - a secret containing a private key file named `rsa_id` that matches a public key configured in the Git server. 
+* `spec.storageClass` - the name of the StorageClass to use for PersistentVolumeClaims created for this EntandoApp. For more information go to [Kubernetes explanation on Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/).


information -> information,

Lyd1aCla1r3 · 2022-04-18T19:07:39Z

vuepress/docs/next/tutorials/devops/caching-and-clustering.md

@@ -11,7 +11,8 @@ The tutorial below covers the basic steps to setup and validate a clustered inst
 In order to scale an Entando Application across multiple nodes, you must provide a storage class that supports
 a `ReadWriteMany` access policy. There are many ways to accomplish this, including using dedicated storage providers like GlusterFS. Cloud Kubernetes providers also offer clustered storage options specific to their implementation, such as Google Cloud File in GKE or Azure Files in AKS.

-If your default class doesn't support `ReadWriteMany`, add the following operator properties to the ConfigMap of your Helm template to use two different storage classes for clustered vs non-clustered storage:
+
+You can use two different storage classes for your clustered vs. non-clustered storage if your default class doesn't support `ReadWriteMany`. Add the following properties to your ConfigMap for the operator:


just fyi ConfigMap and ConfigMap are both being used...

jyunmitch added 2 commits April 1, 2022 13:47

ENDOC-446 change EntandoCompositeApp to EntandoApp in custom-resource…

52fc92c

…s.md

ENDOC-446 update to CR and remove helm

aa7cd09

jyunmitch requested review from nshaw and Lyd1aCla1r3 April 14, 2022 14:02

jyunmitch commented Apr 14, 2022

View reviewed changes

Merge branch 'main' into ENDOC-446

2d6448a

Lyd1aCla1r3 reviewed Apr 14, 2022

View reviewed changes

jyunmitch changed the title ~~Endoc 446~~ Endoc 446-Updates to CR page and remove Helm Apr 14, 2022

ENDOC-446 Apply PR feedback

c620d97

nshaw requested changes Apr 18, 2022

View reviewed changes

ENDOC-446 Apply PR feedback

2c9cc6d

nshaw approved these changes Apr 18, 2022

View reviewed changes

jyunmitch commented Apr 18, 2022

View reviewed changes

Lyd1aCla1r3 reviewed Apr 18, 2022

View reviewed changes

ENDOC-446 Apply PR feedback

0c5f2e2

Lyd1aCla1r3 approved these changes Apr 18, 2022

View reviewed changes

nshaw merged commit 749c6e3 into main Apr 18, 2022

nshaw deleted the ENDOC-446 branch April 18, 2022 21:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Endoc 446-Updates to CR page and remove Helm #487

Endoc 446-Updates to CR page and remove Helm #487

jyunmitch commented Apr 14, 2022 •

edited

Loading

jyunmitch commented Apr 14, 2022

jyunmitch Apr 14, 2022 •

edited

Loading

jyunmitch Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

jyunmitch Apr 18, 2022

Lyd1aCla1r3 Apr 14, 2022

nshaw Apr 18, 2022

Lyd1aCla1r3 Apr 14, 2022

Lyd1aCla1r3 Apr 14, 2022

nshaw Apr 18, 2022

nshaw commented Apr 18, 2022 •

edited

Loading

nshaw Apr 18, 2022

nshaw Apr 18, 2022

jyunmitch Apr 18, 2022

Lyd1aCla1r3 Apr 18, 2022

Lyd1aCla1r3 Apr 18, 2022

Lyd1aCla1r3 Apr 18, 2022


		* Build and deploy the updated bundle.

		<!-- Supply the following parameters:

		@@ -53,8 +59,10 @@ result in the Deployment of one or more Docker images, along with one or more Se

		The Entando Operator itself is also implemented as a Docker Image. You can have a closer look at how it works in the


		You can achieve this by specifying some properties for the EntandoApp component present in the helm generated file. Look at [this](https://github.com/entando-k8s/entando-helm-quickstart) for more info.
		You can achieve this by specifying some properties for the EntandoApp component present in the entandoapp.yaml file.

Endoc 446-Updates to CR page and remove Helm #487

Endoc 446-Updates to CR page and remove Helm #487

Conversation

jyunmitch commented Apr 14, 2022 • edited Loading

jyunmitch commented Apr 14, 2022

jyunmitch Apr 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nshaw commented Apr 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyunmitch commented Apr 14, 2022 •

edited

Loading

jyunmitch Apr 14, 2022 •

edited

Loading

nshaw commented Apr 18, 2022 •

edited

Loading