ENDOC-399 Add a tutorial for changing the context of the entando-de-app #664
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 CR](../../docs/consume/entandoapp-cr.md) to customize the ingress 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 ingress path 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. | ||
|
|
||
| 1. Open the `entando-app.yaml`, which contains several default parameters: | ||
|
|
||
| ```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 EntandoApp defaults to **/entando-de-app**. | ||
|
|
||
| 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 **/entando-de-app** from the path completely, set the value to empty (e.g.: "" ), blank (e.g.: " "), or "/" | ||
|
|
||
| - To change the visible path of the application, enter a value of "/YOUR-INGRESS-PATH" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 CR](../../docs/consume/entandoapp-cr.md) to customize the ingress 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 ingress path 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. | ||
|
|
||
| 1. Open the `entando-app.yaml`, which contains several default parameters: | ||
|
|
||
| ```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 EntandoApp defaults to **/entando-de-app**. | ||
|
|
||
| 3. Input a value for `ingressPath` to change the web context: | ||
|
|
||
| - To remove **/entando-de-app** from the path completely, set the value to empty (e.g.: "" ), blank (e.g.: " "), or "/" | ||
|
|
||
| - To change the visible path of the application, enter a value of "/YOUR-INGRESS-PATH" | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
"which contains several default parameters" << Don't think this is necessary
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.
arguable... it's worth hinting that the yaml doesn't include a comprehensive list of all available parameters and that the one we'll be modifying isn't a default. also, this tutorial is so short i'm stretching what i can...