-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathconfiguring-installation-values.html.md.erb
321 lines (255 loc) · 11.3 KB
/
configuring-installation-values.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
---
title: Configuring Installation Values
owner: Tanzu Application Service Release Engineering
---
This topic describes how to configure installation resources before deploying <%= vars.app_runtime_full %> (<%= vars.app_runtime_short %>) to a Kubernetes cluster.
## <a id='prerequisites'></a> Prerequisites
Before proceeding, complete all sections in:
* [Preparing to Install <%= vars.app_runtime_short %>](preparing-to-install-tas-for-kubernetes.html)
* [Installing Command-Line Tools](installing-command-line-tools.html)
## <a id='overview'></a> Overview
To configure installation values for <%= vars.app_runtime_short %>,
modify a copy of the configuration values template:
* [Copy the Configuration Values Template](#copy-template)
* [Configure Installation Values](#configure-values)
* [Configure Certificates](#configure-certs)
<%#
* [Copy the Configuration Values Template](#copy-template)
* [Configure the System Domain](#configure-system-domain)
* [Configure the Load Balancer](#configure-lb)
* [Configure the Ingress Gateway Certificates](#configure-ingress-cert)
* [(Optional) Configure Application Container Certificates](#configure-app-cert)
* [(Optional) Configure Application Log Destinations](#configure-app-log-destinations)
%>
## <a id='copy-template'></a> Copy the Configuration Values Template
The configuration values template gives you the flexibility to
configure different parts of the system in a single file.
Use a copy of the template as your baseline configuration.
To copy the configuration values template:
1. Open a command line.
1. Change directory to the parent directory that contains the `tanzu-application-service` directory.
1. Create a new directory named `configuration-values`.
Use the new directory to store configuration values for this installation.
1. Duplicate the sample values file:
```
cp tanzu-application-service/sample-values.yml configuration-values/values.yml
```
Customize the new `values.yml` as your configuration values file.
## <a id='configure-values'></a> Configure Installation Values
To configure <%= vars.app_runtime_short %> installation values,
modify your copy of the configuration values template:
* [Configure the System Domain](#configure-system-domain)
* [Configure the Load Balancer](#configure-lb)
* [(Optional) Configure Application Log Destinations](#configure-app-log-destinations)
### <a id='configure-system-domain'></a> Configure the System Domain
To configure your system domain:
1. Open `values.yml` in a text editor.
1. Locate the `system_domain` section in the `values.yml` file.
1. Configure the system domain:
```yaml
system_domain: "SYSTEM-DOMAIN"
app_domains:
#@overlay/append
- "APP-DOMAIN"
```
Where:
- `SYSTEM-DOMAIN` is the system domain you previously selected for your <%= vars.app_runtime_short %> installation.
- `APP-DOMAIN` is a separate, unique domain for hosting apps.
1. Save the `values.yml` file.
### <a id='configure-lb'></a> Configure the Load Balancer
To configure your LoadBalancer service:
1. Open `values.yml` in a text editor.
1. Locate the `load_balancer` section in the `values.yml` file.
1. Configure the LoadBalancer service:
```yaml
ingress:
load_balancer:
enable: ENABLED
static_external_ip: "LOAD-BALANCER"
external_traffic_policy: "POLICY"
```
Where:
* `ENABLED` configures the provisioning of the Kubernetes ingress with a `LoadBalancer` Istio ingress service.
To provision a `LoadBalancer` for the Istio ingress gateway required for <%= vars.app_runtime_short %>,
enable `LoadBalancer` as follows:
<table>
<tr>
<th>Deployment Environment</th>
<th width="20%"><code>enable</code> value</th>
</tr>
<tr>
<td>Tanzu Kubernetes Grid (TKG) on vSphere</td>
<td><code>False</code></td>
</tr>
<tr>
<td>TKG on AWS</td>
<td><code>True</code></td>
</tr>
<tr>
<td>Tanzu Kubernetes Grid Integrated Edition (TKGI) on vSphere with Flannel container networking</td>
<td><code>False</code></td>
</tr>
<tr>
<td>TKGI on vSphere with NSX-T container networking</td>
<td><code>True</code></td>
</tr>
<tr>
<td>TKGI on AWS</td>
<td><code>True</code></td>
</tr>
<tr>
<td>TKGI on Azure</td>
<td><code>True</code></td>
</tr>
<tr>
<td>TKGI on GCP</td>
<td><code>True</code></td>
</tr>
</table>
For more information, see [Kubernetes Services]
(https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
in the Kubernetes documentation.
<br>
* `LOAD-BALANCER` is the static external IP address for the LoadBalancer, if the load balancer is enabled.
* `POLICY` is the endpoint this ingress routes external traffic to:
* For environments that support node-local endpoints, configure `external_traffic_policy` as `Local`.
* For TKG and other environments that do not support node-local endpoints,
configure `external_traffic_policy` as `Cluster`.
1. Save the `values.yml` file.
### <a id='configure-app-log-destinations'></a> (Optional) Configure Application Log Destinations
You can provide one or more destinations for application logs.
These destinations receive all application logs in syslog RFC 5424 format.
This allows integrations with external logging tools like Splunk or ELK.
For more information about the syslog format, see [RFC 5424 - The Syslog Protocol](https://tools.ietf.org/html/rfc5424) in the Internet Engineering Task Force (IETF) documentation.
To configure optional application log destinations:
1. Open `values.yml` in a text editor.
1. Go to the end of the file.
1. Add the following text:
```yaml
app_log_destinations:
```
1. Immediately following that text, add one or more log destinations:
```yaml
#@overlay/append
- host: HOSTNAME
port: PORT
transport: TRANSPORT
insecure_disable_tls_validation: DISABLE-TLS-VALIDATION
```
Where:
* `HOSTNAME` is the hostname of the log destination.
* `PORT` is the TCP port number of the log destination.
* `TRANSPORT` is one of the following:
- `tls` for TLS-encrypted syslog over TCP. This is the default value.
- `tcp` for plaintext syslog over TCP.
* `DISABLE-TLS-VALIDATION` is `true` or `false`. If set to `true`, the
destination TLS certificate is not validated. The default value is `false`.
1. Save the `values.yml` file.
## <a id='configure-certs'></a> Configure Certificates
To configure <%= vars.app_runtime_short %> certificate values,
modify your copy of the configuration values template:
* [Configure the Ingress Gateway Certificates](#configure-ingress-cert)
* [(Optional) Configure Application Container Certificates](#configure-app-cert)
### <a id='configure-ingress-cert'></a> Configure the Ingress Gateway Certificates
<%= vars.app_runtime_short %> requires a certificate to terminate TLS at the ingress gateway
and generates a self-signed TLS certificate for the ingress gateway
if you do not provide one before installing.
To configure ingress gateway certificates:
1. Open `values.yml` in a text editor.
1. Locate the `system_certificate` and `workloads_certificate` sections in the `values.yml` file.
1. Configure the ingress gateway certificates:
```yaml
system_certificate:
crt: "SYSTEM-CERT"
key: "SYSTEM-KEY"
ca: "SYSTEM-CA"
workloads_certificate:
crt: "WORKLOAD-CERT"
key: "WORKLOAD-KEY"
ca: "WORKLOAD-CA"
```
Where:
* `SYSTEM-CERT` is the Base64-encoded certificate for the wildcard subdomain of the system domain. For example, `*.SYSTEM-DOMAIN`.
* `SYSTEM-KEY` is the Base64-encoded private key for the system certificate.
* `SYSTEM-CA` is the Base64-encoded CA certificate used to sign the system certificate.
* `WORKLOAD-CERT` is the Base64-encoded certificate for the wildcard subdomain of the app domain. For example, `*.APP-DOMAIN`.
* `WORKLOAD-KEY` is the Base64-encoded private key for the workload certificate.
* `WORKLOAD-CA` is the Base64-encoded CA certificate used to sign the workload certificate.
1. Save the `values.yml` file.
### <a id='configure-app-cert'></a> (Optional) Configure Application Container Certificates
You can provide one or more certificates for the TAS-deployed applications to trust.
These certificates are injected into the application trust store to
allow apps to communicate with each other securely.
To configure optional application container certificates:
1. Open `values.yml` in a text editor.
1. Locate the `app_containers` section in the `values.yml` file.
1. Configure the application container certificates:
```yaml
app_containers:
#! PEM encoded Certificate Authority
ca: |
-----BEGIN CERTIFICATE-----
FIRST-CA-CERTIFICATE-CONTENT
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
SECOND-CA-CERTIFICATE-CONTENT
-----END CERTIFICATE-----
```
Where:
* `FIRST-CA-CERTIFICATE-CONTENT` is a CA certificate or self-signed certificate of a service.
or application that you want your TAS-deployed app to trust.
* `SECOND-CA-CERTIFICATE-CONTENT` is a CA certificate or self-signed certificate of a service
or application that you want your TAS-deployed app to trust.
Ensure each line of the CA certificate value is indented four spaces,
matching the indentation of the surrounding `BEGIN CERTIFICATE` and `END CERTIFICATE` lines.
1. Save the `values.yml` file.
## <a id="next"></a> Next Steps
After you complete this procedure, complete all of the following configuration procedures:
* [Configuring Your App Image Registry](configuring-app-image-registry.html)
* [Configuring Your System Image Registry](configuring-sys-image-registry.html)
* [Configuring Your System Databases](configuring-system-databases.html)
* [Configuring Apps Manger](configuring-apps-manager.html)
<%#
1. **Application image registry configuration:**
```yaml
app_registry:
hostname: ""
username: ""
password: ""
repository_prefix: ""
```
For more information about configuring application image registry, see [Configuring Application Image Registries](configuring-app-image-registry.html).
1. **System image registry configuration:**
```yaml
system_registry:
hostname: ""
username: ""
password: ""
```
For more information about configuring system image registry, see [Configuring System Image Registries](configuring-sys-image-registry.html).
1. **System databases configuration:**
<%= vars.app_runtime_short % > requires credentials to an external database.
For instructions on how to configure the system database,
see [Configuring Your System Databases](configuring-system-databases.html).
```yaml
capi:
database:
host: ""
user: cloud_controller
password: ""
name: cloud_controller
uaa:
database:
host: ""
user: uaa
password: ""
name: uaa
usage_service:
database:
host: ""
user: usage_service
password: ""
name: usage_service
```
1. **Apps Manager configuration:** for more information, see [Configuring Apps Manager](configuring-apps-manager.html)
%>