Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENDOC-385 tips-and-tricks sheet needs to be reworked/augmented #354

Merged
merged 10 commits into from
Nov 30, 2021
Merged

ENDOC-385 tips-and-tricks sheet needs to be reworked/augmented #354

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a293ecc
ENDOC-385 Revisit existing content
Nov 29, 2021
aa490f7
ENDOC-385 Consistend with Q and A
Nov 29, 2021
000958e
ENDOC-385 Q and A format
Nov 29, 2021
9f0007a
ENDOC-385 Adding NGINX
Nov 29, 2021
1f43a18
ENDOC-385 Remove TKG
Nov 29, 2021
b921805
ENDOC-385 Install timeout addressed
Nov 29, 2021
7859c39
ENDOC-385 All changes -configmap
Nov 30, 2021
3123065
ENDOC-385 Final changes before apply to Next
Nov 30, 2021
69ca540
ENDOC-385 Applied changes to Next
Nov 30, 2021
e1aa63b
ENDOC-385 Resolve conflict
Nov 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions vuepress/docs/v6.3.2/docs/reference/local-tips-and-tricks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,31 @@ The base domain configured via the ENTANDO_DEFAULT_ROUTING_SUFFIX (e.g. in your
### `The IP address changed after the initial install`
- Restarting a Windows computer can cause this (see [Windows Hyper-V IP Changes](#hyper-v-ip-changes) below), and the workaround noted above (e.g. update your /etc/hosts file) also applies. Simply update the IP address in the first column to use the current IP of your virtual machine.

## Customizing NGINX

In some situations the default NGINX ingress configuration doesn't work well for Entando. For instance, JWT tokens can be too large, proxy-buffer-size can be too small, etc. A 502 Bad Gateway error can indicate this config needs to be modified.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A 502 Bad Gateway error can indicate that this config needs to be modified.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not consistent with this... is there a rule about adding words like "that" where they can go but are often skipped?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is kind hazy to me too. I added it by sound. From what i can find, 'this config needs...' works as an object of the sentence and thus needs a 'that'.

here's the best explanation i can find, https://web.ku.edu/~edit/that.html


To configure the NGINX controller globally (for the entire cluster) we just need to edit the default NGINX's configmap, which is ingress-nginx-controller in the ingress-nginx namespace. Add the following inside the data parameter:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To configure the NGINX controller globally (for the entire cluster), we need to edit the default NGINX's ConfigMap,
--added comma, took out just, caps for config map

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just confirming: do we capitalize configmap if it's not an Entando ConfigMap? and ConfigMap is one word?


```
apiVersion: v1
data:
allow-snippet-annotations: "true"
proxy-buffer-size: 24k
kind: ConfigMap
```

Refer to the NGINX troubleshooting sections from each of the cloud install guides (EKS, AKS, GKE, TKG) for more information:

* [Amazon Elastic Kubernetes Service (EKS)](../../tutorials/devops/installation/elastic-kubernetes-service/eks-install.html#appendix-a-troubleshooting)
* [Azure Kubernetes Service (AKS)](../../tutorials/devops/installation/azure-kubernetes-service/azure-install.html#deploy-nginx-ingress-controller)
* [Google Kubernetes Engine (GKE)](../../tutorials/devops/installation/google-cloud-platform/gke-install.html#cluster-setup)
* [Tanzu Kubernetes Grid (TKG)](../../tutorials/devops/installation/tanzu/tanzu-install.html#deploy-the-nginx-ingress-controller)





## Windows Development
### Multipass loses control of VMs
**Q: What do I do if Multipass cannot access my VMs?**
Expand Down