ENDOC-451 Clustering with Redis is missing REDIS_ACTIVE env var #447
Conversation
| @@ -1,41 +1,37 @@ | |||
| # Caching and Clustering | |||
|
|
|||
| The tutorials below cover the basic steps to setup and validate a clustered instance of the Entando App Engine. | |||
| The tutorial below covers the basic steps to setup and validate a clustered instance of the Entando App Engine. | |||
There was a problem hiding this comment.
I think there are multiple tutorials below and that's why it was plural. Not a big deal but may need to add something about that?
There was a problem hiding this comment.
yeah... it seemed kind of awkward to include multiple tutorials on a single page, especially if the "tutorial" consisted of a handle of steps dependent on previous steps. usually tutorials are longer and all-encompassing (aside from links to supplementary material or next steps) and not confined to a section within a page. i changed the language to remove all other references to "this tutorial" when a new topic or set of actions was introduced.
|
|
||
| > **NOTE** | ||
| > | ||
| > When building your deployment architecture it is important to review your goals, hardware, networking, and application specific setup and optimize your App Engine deployment for your environment. None of the configurations or deployments below will address every type of application or deployment. The configuration and testing examples below can be used as building blocks to create a deployment architecture that works for your application. | ||
| > When building your deployment architecture, it is important to review your goals, hardware, networking and application-specific setup. You must also optimize App Engine deployment for your environment. The configurations and tests below do not address every type of application or deployment, but these examples can be used as building blocks to create a deployment architecture that works for your application. |
There was a problem hiding this comment.
"but these examples" >> they
| - The Entando deployment must use an RDBMS, a relational database system in which data is organized in a table structure. Clustered instances will not work correctly with in-memory databases. | ||
| - An existing deployment of an Entando App or the ability to create one. | ||
| - If you haven't created a deployment or don't have a YAML file for an Entando deployment, follow the [Quickstart instructions](../../../docs/getting-started/). | ||
| - The Entando deployment must use a Relational Database Management System (RDBMS) to organize data in a table structure. Clustered instances will not work correctly with in-memory databases. |
There was a problem hiding this comment.
the relational database... is not capitalized, don't think
There was a problem hiding this comment.
i looked it up and it is ?? at least the first google hit thought so... did we decide otherwise?
| 8. Check that the application continues to render while the pod you deleted is no longer present. | ||
| 9. Wait for Kubernetes to restore your deleted pod. | ||
| 10. Check that the application continues to render after the pod is restored. | ||
| - If you want to test at the hardware level, you could manually terminate a node in your cluster (ensuring that the pods are scheduled to different nodes). |
There was a problem hiding this comment.
a little awkward at "If you want to test at". The previous way is awkward too.
There was a problem hiding this comment.
hm i'm used to that phrasing and didn't realize it was awkward!
| 4. Terminate that instance. | ||
| 5. Fetch the data created and check that the recently created data is returned. | ||
| 5. Fetch the recently created data and verify the data are returned. |
There was a problem hiding this comment.
add that>> Fetch the recently created data and verify "that" the data are returned.
| @@ -176,20 +161,21 @@ kubectl apply -f namespace-resources.yaml | |||
| helm template quickstart ./ > my-clustered-app.yaml | |||
| ``` | |||
|
|
|||
| 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: | |||
| 11. Add environment variables to `EntandoApp` for your deployed Redis instance per the output of the Helm template command above (`my-clustered-app.yaml`). The variables to create are: | |||
There was a problem hiding this comment.
I think "per" complicates the sentence. Maybe simplify to "for". Not sure, but has the meaning changed? Do you put the environment variables in "my-clustered-app.yaml? In this edit, it sounds like you put the env var in "EntandoApp" with the information from my-clustered-app.yaml.
There was a problem hiding this comment.
good catch. the way it was worded it seemed like that's what was meant, but reading this like i'm trying to follow an instruction it's obv you're supposed to edit the yaml - how would you even put a variable in EntandoApp?? -_-
| >**NOTE** | ||
| > | ||
| > This example uses a secret for the `REDIS_PASSWORD` which is recommended. You can also hardcode the password in the YAML for testing. However, creating passwords in clear text in your deployment files is not recommended. Create and use a secret for the password as a best practice. | ||
| >NOTE: This example uses a Secret for the `REDIS_PASSWORD`, which is recommended. You can also hardcode the password in the YAML for testing purposes. However, the use of clear text passwords in deployment files is not recommended. |
There was a problem hiding this comment.
Just trying to understand, did something change for 'Create and use a secret for the password as a best practice.'
There was a problem hiding this comment.
it seemed redundant. maybe because i read it so many times... i can put it back in.
No description provided.