Skip to content

Commit 6baba53

Browse files
author
Alexey Lazarenko
committed
JE-65236
1 parent c3c231d commit 6baba53

18 files changed

+92
-92
lines changed

docs/creating-manifest/actions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,9 @@ cmd [nginx]:
246246

247247
### api
248248

249-
Executing actions available by means of [Virtuozzo PaaS Cloud API](http://docs.jelastic.com/api).
249+
Executing actions available by means of [Virtuozzo Application Platform Cloud API](http://docs.jelastic.com/api).
250250

251-
There are a number of parameters required by Virtuozzo PaaS API that are defined automatically:
251+
There are a number of parameters required by Virtuozzo Application Platform API that are defined automatically:
252252

253253
- *envName* - environment domain name where the API method is executed
254254

@@ -280,7 +280,7 @@ api [cp]: api.environment.control.RestartNodes
280280
where:
281281

282282
- `api [cp]` - target node group for the API method execution (*[cp]*)
283-
- *api.environment.control.RestartNodes* - Virtuozzo PaaS API method for restarting nodes by group
283+
- *api.environment.control.RestartNodes* - Virtuozzo Application Platform API method for restarting nodes by group
284284

285285
This method (*api.environment.control.RestartNodes*) can be simplified like shown in the next example.
286286
@@@
@@ -1419,11 +1419,11 @@ script [cp, 12345]: |
14191419
```
14201420
@@!
14211421

1422-
The `script` action provides an ability to execute Virtuozzo PaaS API in custom scripts. Therefore, it is easy to manage Virtuozzo PaaS environments by `scripts`.
1423-
There are [ready-to-go solutions](/samples/#complex-ready-to-go-solutions) certified by Virtuozzo PaaS team.
1422+
The `script` action provides an ability to execute Virtuozzo Application Platform API in custom scripts. Therefore, it is easy to manage Virtuozzo Application Platform environments by `scripts`.
1423+
There are [ready-to-go solutions](/samples/#complex-ready-to-go-solutions) certified by Virtuozzo Application Platform team.
14241424

14251425
!!! note
1426-
Learn more about using <a href="http://docs.jelastic.com/api" target="_blank">Virtuozzo PaaS Cloud API</a>.
1426+
Learn more about using <a href="http://docs.jelastic.com/api" target="_blank">Virtuozzo Application Platform Cloud API</a>.
14271427

14281428
### setGlobals
14291429

@@ -2448,7 +2448,7 @@ where:
24482448

24492449
- `id` - identifier of a custom add-on
24502450

2451-
You can locate the installed add-ons within the **Add-ons** tab at the Virtuozzo PaaS dashboard.
2451+
You can locate the installed add-ons within the **Add-ons** tab at the Virtuozzo Application Platform dashboard.
24522452

24532453
![new-addon](/img/new-addon.png)
24542454

@@ -2527,7 +2527,7 @@ onInstall:
25272527
```
25282528
@@!
25292529

2530-
The result window also returns the compute node's unique identifier at Virtuozzo PaaS Platform.
2530+
The result window also returns the compute node's unique identifier at Virtuozzo Application Platform.
25312531
![returnNodeId](/img/returnNodeId.jpg)
25322532

25332533
If the action returns an object, a response code can be redefined. So the *message* or *result* code parameters are required in the *return* object. Herewith, a zero (0) *result* code is not passed to the response code.

docs/creating-manifest/basic-configs.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,15 @@ envGroups: array/string
9393
@@!
9494

9595
- `type` *[optional]* - type of the application installation. Available values are **install** and **update**. More details described above
96-
- `version` - *[optional]* - JPS type supported by the Virtuozzo PaaS Platform. See the <a href="/virtuozzo-cs-correspondence/" target="_blank">correspondence between version</a> page
96+
- `version` - *[optional]* - JPS type supported by the Virtuozzo Application Platform. See the <a href="/virtuozzo-cs-correspondence/" target="_blank">correspondence between version</a> page
9797
- `name` *[required]* - JPS custom name
9898
- `logo` *[optional]* - JPS image that will be displayed within custom add-ons
9999
- `description` - text string that describes a template. This section should always follow the template format version section
100100
- `homepage` *[optional]* - link to any external application source
101101
- `categories` - categories available for manifests filtering
102102
- `baseUrl` *[optional]* - custom <a href="#relative-links" target="_blank">relative links</a>
103103
- `settings` *[optional]* - custom form with <a href="../visual-settings/" target="_blank">predefined user input elements</a>
104-
- `targetRegions` *[optional]* - filtering available regions on Virtuozzo PaaS platform. Option will be used only with **type** `install`
104+
- `targetRegions` *[optional]* - filtering available regions on Virtuozzo Application Platform. Option will be used only with **type** `install`
105105
- `type` *[optional]* [array] - region's virtualization types
106106
- `name` *[optional]* [string] - text or JavaScript RegExp argument to filtering region's by name
107107
- `region` *[optional]* - region, where an environment will be installed. Option will be used only with **type** `install`
@@ -176,7 +176,7 @@ The list of available parameters are:
176176
- `displayName` *[optional]* - node's display name (i.e. <a href="https://www.virtuozzo.com/application-platform-docs/environment-aliases/" target="_blank">alias</a>)
177177
- `extip` *[optional]* - attaching public IP address to a container. The default value is *'false'*
178178
- `addons` *[optional]* - a list of addons, which will be installed in current `nodeGroup`. Addons will be installed after environment installation and `onInstall` action will be finished. [More details here](/creating-manifest/addons/)
179-
- `tag` *[optional]* - an image tag for `dokerized` Virtuozzo PaaS templates with `nodeType` parameter. Full list of supported tag [here](/creating-manifest/selecting-containers/#dokerized-template-tags)
179+
- `tag` *[optional]* - an image tag for `dokerized` Virtuozzo Application Platform templates with `nodeType` parameter. Full list of supported tag [here](/creating-manifest/selecting-containers/#dokerized-template-tags)
180180
- `scalingMode` *[optional]* - *stateless* or *stateful* [scaling](https://www.virtuozzo.com/application-platform-docs/horizontal-scaling/) mode, the possible values are *'STATELESS'* or *'STATEFUL'* respectively. The default value is *'STATEFUL'* for *nodeGroup* types: *bl,cp,vds*. For the rest of *nodeGroup* types the default value is *'STATELESS'*
181181
- `diskLimit` *[optional]* - sets a storage size limit. The default value is equal to disk quota for current *nodeGroup*. It is measured in GB by default. The MB and TB can be used as well. Examples:
182182
- 10 = 10 GB
@@ -400,7 +400,7 @@ The service starts if:
400400

401401
#### Cluster
402402

403-
In Virtuozzo PaaS the following *[nodeTypes](https://docs.cloudscripting.com/creating-manifest/selecting-containers/#supported-stacks)* can be clusterized with help of built-in [Auto-Сlustering feature](https://www.virtuozzo.com/application-platform-ops-docs/auto-clustering-templates/):
403+
In Virtuozzo Application Platform the following *[nodeTypes](https://docs.cloudscripting.com/creating-manifest/selecting-containers/#supported-stacks)* can be clusterized with help of built-in [Auto-Сlustering feature](https://www.virtuozzo.com/application-platform-ops-docs/auto-clustering-templates/):
404404

405405
* Application Servers: GlassFish, WildFly, Payara
406406
* SQL Databases: MySQL, MariaDB, PostgreSQL
@@ -545,7 +545,7 @@ The setting is stored in *nodeGroup* settings and [can be overridden via API](#u
545545
<!-- RegionFiltering section -->
546546
### Regions Filtering
547547

548-
Virtuozzo PaaS provides a possibility to use multiple availability regions within a single PaaS installation. The number of hardware regions depends on user account and hosting provider.
548+
Virtuozzo Application Platform provides a possibility to use multiple availability regions within a single PaaS installation. The number of hardware regions depends on user account and hosting provider.
549549

550550
If multiple regions are available, the environment will be created at one that is chosen based on the following filtering rules:
551551

@@ -887,7 +887,7 @@ nodes:
887887
```
888888
@@!
889889

890-
Environment variables can manage to control nodes availability from outside to the platform. <a href="https://www.virtuozzo.com/application-platform-docs/custom-firewall/" target="_blank">Virtuozzo PaaS Container Firewall</a> feature was implemented in Virtuozzo PaaS version 5.4 and new firewall rules can be set during creating new environment.<br>
890+
Environment variables can manage to control nodes availability from outside to the platform. <a href="https://www.virtuozzo.com/application-platform-docs/custom-firewall/" target="_blank">Virtuozzo Application Platform Container Firewall</a> feature was implemented in Virtuozzo Application Platform version 5.4 and new firewall rules can be set during creating new environment.<br>
891891
The reserved environment variable for this option is - **JELASTIC_PORTS**. This parameter defines which ports will be added in *inbound* rules. All rules in this case will be added for both protocols (**TCP/UDP**).
892892

893893
@@@
@@ -917,7 +917,7 @@ nodes:
917917
All ports for output traffic are opened by default.
918918

919919
Another one reserved environment variables is **ON_ENV_INSTALL**. This variable is responsible for executing new JPS installation after new nodeGroup (layer of nodes) has been created.<br>
920-
This variable for **nodeGroup** can be set in JPS or via dashboard. More info about Docker configuration is Virtuozzo PaaS dashboard <a href="https://www.virtuozzo.com/application-platform-docs/container-configuration/" target="_blank">here</a>.
920+
This variable for **nodeGroup** can be set in JPS or via dashboard. More info about Docker configuration is Virtuozzo Application Platform dashboard <a href="https://www.virtuozzo.com/application-platform-docs/container-configuration/" target="_blank">here</a>.
921921

922922
!!! note
923923
> By default in manifest from the **ON_ENV_INSTALL** variable *\${settings.nodeGroup}* placeholder is defined. It will be a nodeGroup value where this manifest is executed.
@@ -1117,7 +1117,7 @@ startPage: ${env.url}customDirectory/
11171117

11181118
###Skip Node Emails
11191119

1120-
By default in Virtuozzo PaaS, a user is informed via email about adding new nodes into environments. In Cloud Scripting there is an ability to set an option to skip these emails upon environment creation:
1120+
By default in Virtuozzo Application Platform, a user is informed via email about adding new nodes into environments. In Cloud Scripting there is an ability to set an option to skip these emails upon environment creation:
11211121
- globally for all *nodeTypes*
11221122
- for specific *nodeTypes*
11231123
This option does not affect the email notification upon node addition by scaling.
@@ -1253,7 +1253,7 @@ The error 11022 is ignored and gets to no crash report.
12531253

12541254
##Relative Links
12551255

1256-
The relative links functionality is intended to specify the JPS file’s base URL, in relation to which the subsequent links can be set throughout the manifest. This source destination (URL) can point either to the text of the file or its raw code. Therefore, it is passed in the manifest through the <b>*baseUrl*</b> parameter or specified while <a href="https://www.virtuozzo.com/application-platform-docs/environment-export-import/" target="_blank">importing</a> a corresponding JPS file via the Virtuozzo PaaS dashboard.
1256+
The relative links functionality is intended to specify the JPS file’s base URL, in relation to which the subsequent links can be set throughout the manifest. This source destination (URL) can point either to the text of the file or its raw code. Therefore, it is passed in the manifest through the <b>*baseUrl*</b> parameter or specified while <a href="https://www.virtuozzo.com/application-platform-docs/environment-export-import/" target="_blank">importing</a> a corresponding JPS file via the Virtuozzo Application Platform dashboard.
12571257

12581258
!!! note
12591259
> The *baseUrl* value declared within the manifest has higher priority than installation via URL (i.e. <a href="https://www.virtuozzo.com/application-platform-docs/environment-export-import/" target="_blank">Import</a>).
@@ -1289,7 +1289,7 @@ success: README.md
12891289
```
12901290
@@!
12911291

1292-
In case of the manifest installation via URL by means of the Virtuozzo PaaS **Import** functionality, the `baseUrl` placeholder will be defined if the specified path is set as in the example below:
1292+
In case of the manifest installation via URL by means of the Virtuozzo Application Platform **Import** functionality, the `baseUrl` placeholder will be defined if the specified path is set as in the example below:
12931293

12941294
```
12951295
${baseUrl}/manifest.jps
@@ -1338,7 +1338,7 @@ success: text.txt
13381338
```
13391339
@@!
13401340

1341-
In the example above the text *text.txt* will be displayed in success email notification and in success window in Virtuozzo PaaS dashboard when JPS installation will be finished. If URL **https://example.com/text.txt** has any content then that content will be displayed.
1341+
In the example above the text *text.txt* will be displayed in success email notification and in success window in Virtuozzo Application Platform dashboard when JPS installation will be finished. If URL **https://example.com/text.txt** has any content then that content will be displayed.
13421342

13431343
The Cloud Scripting engine also supports a `${baseUrl}` placeholder. It can be used throughout the users’ customs scripts (within the <a href="../actions/#cmd" target="_blank">*cmd*</a> and <a href="../actions/#script" target="_blank">*script*</a> actions).
13441344

0 commit comments

Comments
 (0)