forked from pivotal-cf/docs-tas-kubernetes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
configuring-apps-manager.html.md.erb
356 lines (289 loc) · 16.3 KB
/
configuring-apps-manager.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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
---
title: Configuring Apps Manager for Tanzu Application Service for Kubernetes
owner: Apps Manager
---
This topic describes how to customize the Apps Manager deployed with
Tanzu Application Service for Kubernetes (TAS for Kubernetes).
## <a id='overview'></a> Overview
Apps Manager on TAS for Kubernetes provides a UI for
creating and deleting orgs, domains and spaces, and
managing services, members, and permissions.
You can use Apps Manager's default configuration, or
you can customize Apps Manager in any of the following ways:
* Modify resource consumption
* Customize the Marketplace
* White-label the UI
* Disable/Enable features
<br>
To customize Apps Manager:
* [Create the Apps Manager Configuration File](#create-configuration)
* [Configure Apps Manager](#configure-apps-manager)
<br>
For more information about Apps Manager, see
[Getting Started with Apps Manager](https://docs.run.pivotal.io/console/dev-console.html).
## <a id='prerequisites'></a> Prerequisites
Before configuring Apps Manager, complete the following:
* Complete the steps in
[Configuring Installation Values for TAS for Kubernetes](configuring-installation-values.html).
* Ensure that your installation has a `configuration-values` directory within the
`tanzu-application-service` directory. For more information, see
[Generate Internal Configuration Values](configuring-installation-values.html#generate-configuration-values)
in _Configuring Installation Values for TAS for Kubernetes_.
## <a id='create-configuration'></a> Create the Apps Manager Configuration File
Apps Manager configuration settings are stored in the
`apps-manager-values.yml` configuration file.
You must manually create the `apps-manager-values.yml` file.
To create the `apps-manager-values` configuration file:
1. Change directory to the `configuration-values` directory.
1. Create a file named `apps-manager-values.yml` in the `configuration-values` directory.
1. Copy the following into the `apps-manager-values.yml` file:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
apps_manager:
whitelabeling:
product_name: "Apps Manager"
```
## <a id='configure-apps-manager'></a> Configure Apps Manager
You can customize Apps Manager and configure resource usage by modifying
the `apps-manager-values.yml` configuration file.
The Apps Manager configuration file you create
should be a well formatted YAML file. For example:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
apps_manager:
poll_interval: 30
resources:
memory: 128
whitelabeling:
accent_color: "#00A79D"
search_server:
resources:
instances: 2
invitations:
resources:
instances: 2
memory: 256
```
To customize Apps Manager:
1. Change directory to the `configuration-values` directory.
1. Edit the `apps-manager-values.yml` file.
1. Complete one or more of the following:
* [Configure Apps Manager Base Settings](#customize-apps-manager-configuration)
* [Configure Apps Manager Resources](#customize-apps-manager-resources)
* [Configure Apps Manager White-Labeling](#customize-apps-manager-white-label)
* [Configure the Apps Manager Search Server](#customize-apps-manager-searchserver)
* [Configure Apps Manager Invitations](#customize-apps-manager-invitations)
### <a id='customize-apps-manager-configuration'></a> Configure Apps Manager Base Settings
To configure Apps Manager base settings:
1. Ensure the `apps-manager-values.yml` file has an `apps_manager:` section.
1. Add the desired property configuration, using `property: value` format.
See [Configurable Apps Manager Base Settings](#apps-manager-base-settings) below.
1. Review the completed file. The configuration file you create
should be a well formatted YAML file.
<br>
For example:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
apps_manager:
currency_lookup: {"usd":"$","eur":"€"}
display_plan_prices: "false"
enable_invitations: "true"
poll_interval: 30
app_details_poll_interval: 10
```
#### <a id='apps-manager-base-settings'></a> Configurable Apps Manager Base Settings
The following are all of the configurable Apps Manager base settings:
<table class="nice">
<tr>
<th width="40%">Property</th>
<th widt="20%">Default Value</th>
<th width="40%">Description</th>
</tr>
<tr><td>currency\_lookup</td><td>{"usd":"$","eur":"€"}</td><td>Supported currency symbols</td></tr>
<tr><td>display\_plan\_prices</td><td>false</td><td>Display Marketplace Service Plan Prices</td></tr>
<tr><td>enable\_invitations</td><td>true</td><td>Enable inviting users through the invitation service</td></tr>
<tr><td>poll\_interval</td><td>30</td><td>The Apps Manager poll interval. Enter value in seconds.</td></tr>
<tr><td>app\_details\_poll\_interval</td><td>10</td><td>The app details polling interval. Enter value in seconds.</td></tr>
</table>
### <a id='customize-apps-manager-resources'></a> Configure Apps Manager Resources
To configure Apps Manager resource usage settings:
1. Ensure the `apps-manager-values.yml` file has an `apps_manager:` section.
1. Ensure the `apps_manager:` section includes a `resources:` sub-section.
1. Add the desired property configuration, using `property: value` format.
See [Configurable Apps Manager Resource Settings](#apps-manager-resource-settings) below.
11. Review the completed file. The configuration file you create
should be a well formatted YAML file.
<br>
For example:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
apps_manager:
resources:
instances: 1
memory: 128
```
1. Save the configuration file.
#### <a id='apps-manager-resource-settings'></a> Configurable Apps Manager Resource Settings
The following are all of the configurable Apps Manager resource usage settings:
<table class="nice">
<tr>
<th width="40%">Property</th>
<th widt="20%">Default Value</th>
<th width="40%">Description</th>
</tr>
<tr><td>instances</td><td>1</td><td>Deployed instances of Apps Manager.</td></tr>
<tr><td>memory</td><td>128</td><td>Memory usage of Apps Manager in MB. Supports units, for example, `1GB`, `512MB`.</td></tr>
</table>
### <a id='customize-apps-manager-searchserver'></a> Configure Apps Manager Search Server
To configure Apps Manager Search Server settings:
1. Ensure the `apps-manager-values.yml` file has an `search_server:` section.
1. Ensure the `search_server:` section includes a `resources:` sub-section.
1. Add the desired property configuration, using `property: value` format.
See [Configurable Apps Manager Search Server Settings](#apps-manager-search-server) below.
1. Review the completed file. The configuration file you create
should be a well formatted YAML file.
<br>
For example:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
search_server:
resources:
instances: 2
memory: 256
```
1. Save the configuration file.
#### <a id='apps-manager-search-server'></a> Configurable Apps Manager Search Server Settings
The following are all of the configurable Apps Manager Search Server settings:
<table class="nice">
<tr>
<th width="40%">Property</th>
<th widt="20%">Default Value</th>
<th width="40%">Description</th>
</tr>
<tr><td>instances</td><td>2</td><td>Deployed instances of Apps Manager Search Server.</td></tr>
<tr><td>memory</td><td>256</td><td>Memory usage of the search server app in MB. Supports units, for example, `1GB`, `512MB`.</td></tr>
</table>
### <a id='customize-apps-manager-invitations'></a> Configure Apps Manager Invitations
To configure Apps Manager Invitations settings:
1. Ensure the `apps-manager-values.yml` file has an `invitations:` section.
1. Ensure the `invitations:` section includes a `resources:` sub-section.
1. Add the desired property configuration, using `property: value` format.
See [Configurable Apps Manager Invitations Settings](#apps-manager-invitations-settings) below.
1. Review the completed file. The configuration file you create
should be a well formatted YAML file.
<br>
For example:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
invitations:
resources:
instances: 2
memory: 256
```
1. Save the configuration file.
#### <a id='apps-manager-invitations-settings'></a> Configurable Apps Manager Invitations Settings
The following are all of the configurable Apps Manager Invitations settings:
<table class="nice">
<tr>
<th width="40%">Property</th>
<th widt="20%">Default Value</th>
<th width="40%">Description</th>
</tr>
<tr><td>instances</td><td>2</td><td>Deployed instances of Apps Manager Invitations.</td></tr>
<tr><td>memory</td><td>256</td><td>Memory usage of the invitations apps in MB. Supports units, for example, `1GB`, `512MB`.</td></tr>
</table>
### <a id='customize-apps-manager-white-label'></a> Configure Apps Manager White-Labeling
To configure Apps Manager White-Labeling settings:
1. Ensure the `apps-manager-values.yml` file has an `apps_manager:` section.
1. Ensure the `apps_manager:` section includes a `whitelabeling:` sub-section.
1. Add the desired property configuration, using `property: value` format.
See [Configurable Apps Manager White-Label Settings](#apps-manager-white-label-settings) below.
1. Review the completed file. The configuration file you create
should be a well formatted YAML file.
<br>
For example:
```yaml
#@library/ref "@github.com/pivotal/apps-manager-k8s-release"
#@data/values
---
apps_manager:
whitelabeling:
product_name: "Apps Manager"
accent_color: "#00A79D"
favicon: ""
footer_links: "[]"
```
1. Save the configuration file.
#### <a id='apps-manager-white-label-settings'></a> Configurable Apps Manager White-Label Settings
The following are all of the configurable Apps Manager White-Label settings:
<table class="nice">
<tr>
<th width="40%">Property</th>
<th widt="20%">Default Value</th>
<th width="40%">Description</th>
</tr>
<tr><td>app\_icon</td><td>tanzu icon</td><td>Icon for apps manager UAA portal link</td></tr>
<tr><td>company\_name</td><td>"VMware"</td><td>Custom company name to display.</td></tr>
<tr><td>product\_name</td><td>"Apps Manager"</td><td>Custom product name to display.</td></tr>
<tr><td>accent\_color</td><td>#00A79D</td><td>Custom color for the app. Enter a hexadecimal color code. For example, "#71ffda".</td></tr>
<tr><td>favicon</td><td>""</td><td>Custom favicon. Enter a base64-encoded PNG image string, leaving out the mime-typ (data:image/png;base64,) string.</td></tr>
<tr><td>footer\_links</td><td>"[]"</td><td>Json array of links for the footer (format '[{"name":"link", "href": "https://google.com"}]'</td></tr>
<tr><td>footer\_text</td><td>""</td><td>Custom footer text.</td></tr>
<tr><td>global\_wrapper\_bg\_color</td><td>"#D6D6D6"</td><td>Classification header and footer background color. Enter a hexadecimal color code. For example, "#71ffda".</td></tr>
<tr><td>global\_wrapper\_text\_color</td><td>"#333"</td><td>Classification header and footer text color. Enter a hexadecimal color code. For example, "#71ffda".</td></tr>
<tr><td>global\_wrapper\_footer\_content</td><td>""</td><td>Classification footer content. Enter plain text or HTML markup.</td></tr>
<tr><td>global\_wrapper\_header\_content</td><td>""</td><td>Classification header content. Enter plain text or HTML markup.</td></tr>
<tr><td>logo</td><td>""</td><td>Custom logo. Enter a base64-encoded PNG image string, leaving out the mime-typ (data:image/png;base64,) string.</td></tr>
<tr><td>marketplace\_name</td><td>"Marketplace"</td><td>Name of the marketplace. Enter plain text or HTML markup</td></tr>
<tr><td>marketplace\_url</td><td>"/marketplace"</td><td>Apps Manager Marketplace link to point to a custom marketplace.</td></tr>
<tr><td>secondary\_navigation\_links</td><td>'[{"name":"Docs","href":"https://docs.run.pivotal.io"},{"name":"Tools","href":"/tools"}]'</td><td>List of secondary navigation links of Apps Manager. Enter json string.</td></tr>
</table>
<%#
### <a id='available-configurations'></a> Available Configurations
The following are all of the configurable Apps Manager "whitelabeling", "resources", and other various tooling settings:
<table class="nice">
<tr>
<th width="40%">Property</th>
<th widt="20%">Default Value</th>
<th width="40%">Description</th>
</tr>
<tr><td>apps\_manager.currency\_lookup</td><td> '{"usd":"$","eur":"€"}'</td><td>Supported currency symbols</td></tr>
<tr><td>apps\_manager.display\_plan\_prices</td><td>false</td><td>Display Marketplace Service Plan Prices</td></tr>
<tr><td>apps\_manager.enable\_invitations</td><td>true</td><td>Enable inviting users through the invitation service</td></tr>
<tr><td>apps\_manager.poll\_interval</td><td>30</td><td>The Apps Manager poll interval. Enter value in seconds.</td></tr>
<tr><td>apps\_manager.app\_details\_poll\_interval</td><td>10</td><td>The app details polling interval. Enter value in seconds.</td></tr>
<tr><td>apps\_manager.whitelabeling.app\_icon</td><td>tanzu icon</td><td>Icon for apps manager UAA portal link</td></tr>
<tr><td>apps\_manager.whitelabeling.company\_name</td><td>"VMware"</td><td>Custom company name to display.</td></tr>
<tr><td>apps\_manager.whitelabeling.product\_name</td><td>"Apps Manager"</td><td>Custom product name to display.</td></tr>
<tr><td>apps\_manager.whitelabeling.accent\_color</td><td>#00A79D</td><td>Custom color for the app. Enter a hexadecimal color code. For example, "#71ffda".</td></tr>
<tr><td>apps\_manager.whitelabeling.favicon</td><td>""</td><td>Custom favicon. Enter a base64-encoded PNG image string, leaving out the mime-typ (data:image/png;base64,) string.</td></tr>
<tr><td>apps\_manager.whitelabeling.footer\_links</td><td>"[]"</td><td>Json array of links for the footer (format '[{"name":"link", "href": "https://google.com"}]'</td></tr>
<tr><td>apps\_manager.whitelabeling.footer\_text</td><td>""</td><td>Custom footer text.</td></tr>
<tr><td>apps\_manager.whitelabeling.global\_wrapper\_bg\_color</td><td>"#D6D6D6"</td><td>Classification header and footer background color. Enter a hexadecimal color code. For example, "#71ffda".</td></tr>
<tr><td>apps\_manager.whitelabeling.global\_wrapper\_text\_color</td><td>"#333"</td><td>Classification header and footer text color. Enter a hexadecimal color code. For example, "#71ffda".</td></tr>
<tr><td>apps\_manager.whitelabeling.global\_wrapper\_footer\_content</td><td>""</td><td>Classification footer content. Enter plain text or HTML markup.</td></tr>
<tr><td>apps\_manager.whitelabeling.global\_wrapper\_header\_content</td><td>""</td><td>Classification header content. Enter plain text or HTML markup.</td></tr>
<tr><td>apps\_manager.whitelabeling.logo</td><td>""</td><td>Custom logo. Enter a base64-encoded PNG image string, leaving out the mime-typ (data:image/png;base64,) string.</td></tr>
<tr><td>apps\_manager.whitelabeling.marketplace\_name</td><td>"Marketplace"</td><td>Name of the marketplace. Enter plain text or HTML markup</td></tr>
<tr><td>apps\_manager.whitelabeling.marketplace\_url</td><td>"/marketplace"</td><td>Apps Manager Marketplace link to point to a custom marketplace.</td></tr>
<tr><td>apps\_manager.whitelabeling.secondary\_navigation\_links</td><td>'[{"name":"Docs","href":"https://docs.run.pivotal.io"},{"name":"Tools","href":"/tools"}]'</td><td>List of secondary navigation links of Apps Manager. Enter json string.</td></tr>
<tr><td>apps\_manager.resources.instances</td><td>1</td><td>Deployed Instances of Apps Manager</td></tr>
<tr><td>apps\_manager.resources.memory</td><td>128</td><td>Memory usage of Apps Manager in MB. Supports units, for example, `1GB`, `512MB`.</td></tr>
<tr><td>search\_server.resources.instances</td><td>2</td><td>Deployed Instances of Apps Manager</td></tr>
<tr><td>search\_server.resources.memory</td><td>256</td><td>Memory usage of the search server app in MB. Supports units, for example, `1GB`, `512MB`.</td></tr>
<tr><td>invitations.resources.instances</td><td>2</td><td>Deployed Instances of Apps Manager</td></tr>
<tr><td>invitations.resources.memory</td><td>256</td><td>Memory usage of the invitations apps in MB. Supports units, for example, `1GB`, `512MB`.</td></tr>
</table>
%>