Skip to content

Commit c29fcd5

Browse files
committed
#701 update docs
1 parent 93e634c commit c29fcd5

2 files changed

Lines changed: 82 additions & 0 deletions

File tree

docs/accounts.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,22 @@ harness:
6262
secured: open
6363
```
6464

65+
#### Proxy specific configurations
66+
Proxy configurations can be personalized in the application in the case that we want to have more restrictive values than the global ones (see [here] for more (./ingress-domains-proxies.md#proxy-configurations))
6567

68+
```yaml
69+
harness:
70+
proxy:
71+
timeout:
72+
# -- Timeout for proxy connections in seconds.
73+
send:
74+
# -- Timeout for proxy responses in seconds.
75+
read:
76+
keepalive:
77+
payload:
78+
# -- Maximum size of payload in MB
79+
max:
80+
```
6681
### Secure an enpoint with OpenAPI
6782

6883
In every api endpoint that you want to secure, add the bearerAuth security as in the example:

docs/ingress-domains-proxies.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Ingress, domains and proxies
2+
3+
## Default configurations for domain and subdomains
4+
Cloud Harness makes it very easy to configure domains and proxies, by making
5+
an underlying assumption:
6+
7+
- Applications share a main base domain (say ch.org)
8+
- Applications can define a subdomain (say myapp)
9+
10+
The main domain is configured in the [root values file](../deployment-configuration/values-template.yaml) and
11+
it is usually overridden by the `harness-deployment` command, e.g.
12+
13+
```
14+
harness-deployment ... -d ch.org
15+
```
16+
17+
The subdomain is defined in the application's values.yaml file in
18+
harness.subdomain (see for instance the [samples application configuration](../applications/samples/deploy/values.yaml))
19+
20+
For instance on applications/myapp/deploy/values.yaml:
21+
22+
```yaml
23+
harness:
24+
subdomain: myapp
25+
```
26+
27+
The above configurations put together create an ingress configuration for https://myapp.ch.org and automatically configure letsencrypt to create and renew certificates.
28+
29+
Note:
30+
that the tls and letsencrypt configurations are enabled by default but should usually be disabled locally with
31+
32+
```
33+
harness-deployment ... -dtls -l
34+
```
35+
36+
## Main application
37+
38+
The "main" application is deployed on the base domain.
39+
In order to specify a main application, override the [root values file](../deployment-configuration/values-template.yaml)
40+
41+
Example
42+
```yaml
43+
mainapp: myapp
44+
```
45+
This creates a reverse proxy to https://ch.org pointing to myapp
46+
47+
## Proxy configurations
48+
49+
Ingress is a reverse proxy and as such has some configurations to take into account.
50+
The most common configurations are connection timeouts and payload size.
51+
52+
```yaml
53+
proxy:
54+
timeout:
55+
# -- Timeout for proxy connections in seconds.
56+
send:
57+
# -- Timeout for proxy responses in seconds.
58+
read:
59+
keepalive:
60+
payload:
61+
# -- Maximum size of payload in MB
62+
max:
63+
```
64+
65+
Note that in the case that gatekeepers are enabled, the same configurations are applied
66+
to the gatekeepers, unless the application override them on `harness.proxy.*`.
67+
See also the [gatekeepers documentation](./accounts.md#secure-and-enpoint-with-the-gatekeeper).

0 commit comments

Comments
 (0)