ENDOC-399 Add a tutorial for changing the context of the entando-de-app #664
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| sidebarDepth: 2 | ||
| --- | ||
|
|
||
| # Configure the Entando App Context | ||
| This tutorial describes how to modify the [EntandoApp CRD](../../docs/consume/entandoapp-cr.md) to customize the context path of an Entando App Engine deployment. | ||
|
|
||
| ## Prerequisites | ||
| - 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/README.md). | ||
|
|
||
| ## Remove or Replace entando-de-app | ||
|
|
||
| The web context of the App Engine currently defaults to **/entando-de-app**, which is visible in the URL. Follow the steps below to remove or replace this value. | ||
|
There was a problem hiding this comment. @nshaw should we change the language in the table on the linked page? There was a problem hiding this comment. @Lyd1aCla1r3 Maybe I'm missing it. The getting-started/README seems okay to me There was a problem hiding this comment. @nshaw sorry - this page https://developer.entando.com/next/docs/consume/entandoapp-cr.html - the table entry for ingressPath There was a problem hiding this comment. @Lyd1aCla1r3 hah, that may have been one I was looking at. Yeah, I think we should clean that up. And it could be useful to add it to the navigation under consume since it's an important reference and hard to find right now. |
||
|
|
||
| 1. Open the `entando-app.yaml`, which contains several default paramters: | ||
|
|
||
|
|
||
| ```yaml | ||
| apiVersion: entando.org/v1 | ||
| kind: EntandoApp | ||
| metadata: | ||
| namespace: entando | ||
| name: quickstart | ||
| spec: | ||
| environmentVariables: null | ||
| dbms: embedded | ||
| ingressHostName: YOUR-HOST-NAME | ||
| standardServerImage: eap | ||
| replicas: 1 | ||
| ``` | ||
|
|
||
| 2. Under `spec`, add the parameter `ingressPath`. If this parameter is not present, the path for the `entando-de-app` defaults to **/entando-de-app**. | ||
|
There was a problem hiding this comment.
it sounded a bit funny repeated here There was a problem hiding this comment. i wanted to make the connection that the EntandoApp's server-side/consumer representation was the Entando App Engine, aka the entando-de-app... otherwise it's like, why this default? subtle and repetitive but technically correct and connects some dots... |
||
|
|
||
| 3. Input a value for `ingressPath` to change the web context: | ||
|
There was a problem hiding this comment. Input a value >> enter a value or null values to... it doesn't explain the two different options There was a problem hiding this comment. hm i actually think this drives home the point that something needs to be entered; a null value is still a value, like 0 is still a value. if you add the parameter and leave the field blank things break There was a problem hiding this comment. It makes it sound as if you have to enter a value by this instruction, but the second option below says otherwise. And null value is a blank or no value. 0 is not a null value, pretty sure. Reading the whole section I can see that there are two options. But just reading line 34, you are surprised that you can add a blank. That's all. and not a big deal There was a problem hiding this comment. but both 0 and null are values (you're right that 0 != null), as is a space, or empty quotes. i guess my point is that you have to add a character, even if that character is invisible. if you don't, it will error. so i didn't want to mislead and define values as only characters of a certain kind. i'll look at it again |
||
|
|
||
| - To remove mention of the deployment and show only a forward slash, set the value to empty (e.g.: "" ), blank (e.g.: " "), or "/" | ||
|
There was a problem hiding this comment. "To remove mention of the deployment" -> "To remove /entando-de-app from the path completely" |
||
|
|
||
| - To change the name of the deployment, enter a value of "YOUR-DEPLOYMENT-NAME/" | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. right - slash on the wrong side :) |
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor, CR rather than CRD.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"context path" -> "ingress path".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nshaw should any/all of the CRDs on the linked page be corrected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also luigi said "in the entandoapp CRD" ?? i feel like we might need to take another pass at the docs to straighten out CR/CRD mentions ??
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that's incorrect, also incorrect in the opening paragraph of this page. The only CRDs are the cluster-scoped definitions (all with kind: CustomResourceDefinition) which define what the custom resources (CRs) are. An EntandoApp is a custom resource. Maybe we can try to fix this page and then open a ticket for further docs review.