-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
WWCoE CI admin
committed
Aug 11, 2023
1 parent
3910e50
commit 3dd41f8
Showing
137 changed files
with
2,631 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| ## v2.35.0 - 11 Aug 2023 | ||
|
|
||
| ## v2.34.1 - 08 Aug 2023 | ||
|
|
||
| ### Fixes | ||
|
|
||
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/abx-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/actions-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/bsc-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/cs-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/polyglot-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/ssh-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/typescript-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/vcd-ng-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/vra-ng-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/vra-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/vrealize-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/vrli-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/vrops-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/versions/latest/General/Cheatsheets/xml-plugin-arguments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
docs/versions/v2.35.0/Components/Archetypes/General/Goals/Vrealize Clean.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Vrealize Clean | ||
| vrealize:clean is a goal used to clean up archetype packages on a given environment. | ||
|
|
||
| ## Overview | ||
|
|
||
| vrealize:clean gives us a lot of flexibility in what is going to be deleted. You can find more about the different options | ||
| in the sections below | ||
|
|
||
| ## Table Of Contents: | ||
| 1. [Archetype Support for vrealize:clean](#archetype-support-for-vrealize--clean) | ||
| 2. [Usage](#usage) | ||
|
|
||
| ### Archetype Support for vrealize:clean | ||
|
|
||
| | Archetype | Supported | Comment | | ||
| |-----------|-----------|-------------------------------------------------------------------| | ||
| | vra | Yes | - | | ||
| | vro | Yes | - | | ||
| | vcd | Partial | It does not support dryRunning | | ||
| | abx | No | Not implemented | | ||
| | vrops | No | Not implemented | | ||
| | vra-ng | No | Aria Automation does not support packaging | | ||
| | vrli | No | vRLI does not provide native package support | | ||
| | cs | No | Code Stream Services does not provide native support for packages | | ||
|
|
||
| ### Usage | ||
|
|
||
| `mvn vrealize:clean -DincludeDependencies=true -DcleanUpOldVersions=true -DcleanUpLastVersion=false -Ddryrun=true -P${PROFILE}` | ||
|
|
||
| - includeDependencies - a flag depicting if dependencies should also be deleted | ||
| - cleanUpOldVersions - a flag depicting if old versions of the package (and dependencies in case of includeDependencies) should be deleted | ||
| - cleanUpLastVersion - a flag depicting if the latest version should also be deleted before importing | ||
| - dryrun - Dryrun or not | ||
|
|
31 changes: 31 additions & 0 deletions
31
docs/versions/v2.35.0/Components/Archetypes/Polyglot/General/New Project.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # New Project | ||
|
|
||
| ## Table Of Contents: | ||
| 1. [Generate A New Project](#generate-a-new-project) | ||
|
|
||
| ### Generate A New Project | ||
|
|
||
| - Replace `archetypeVersion` with the latest toolchain version | ||
| - Specify `type` to be either `abx` (vRA ABX Actions) or `vro` (vRO Polyglot Actions). | ||
|
|
||
| ```bash | ||
| #vRO: | ||
| mvn archetype:generate \ | ||
| -DinteractiveMode=false \ | ||
| -DarchetypeGroupId=com.vmware.pscoe.polyglot.archetypes \ | ||
| -DarchetypeArtifactId=package-polyglot-archetype \ | ||
| -DarchetypeVersion={LATEST_VERSION} \ | ||
| -DgroupId=com.vmware.pscoe \ | ||
| -DartifactId=testvronew \ | ||
| -Dtype=vro | ||
|
|
||
| #ABX: | ||
| mvn archetype:generate \ | ||
| -DinteractiveMode=false \ | ||
| -DarchetypeGroupId=com.vmware.pscoe.polyglot.archetypes \ | ||
| -DarchetypeArtifactId=package-polyglot-archetype \ | ||
| -DarchetypeVersion={LATEST_VERSION} \ | ||
| -DgroupId=com.vmware.pscoe \ | ||
| -DartifactId=testabxnew \ | ||
| -Dtype=abx | ||
| ``` |
50 changes: 50 additions & 0 deletions
50
docs/versions/v2.35.0/Components/Archetypes/Polyglot/General/Project Structure.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Project Structure | ||
|
|
||
| ## Overview | ||
| The polyglot archetype supports multiple actions in the src folder. Each has it's own structure depending on the type of the package. | ||
|
|
||
| ## Table Of Contents: | ||
| 1. [General](#general) | ||
| 2. [Templates](#templates) | ||
| 3. [NodeJS](#nodejs) | ||
| 4. [Python](#python) | ||
| 5. [Powershell](#powershell) | ||
|
|
||
| ### General | ||
| - `polyglot.json` - marks a folder as a polyglot package. Contains information about the package. | ||
| - If the `platform.action` is set to `auto` the name of the folder will be used as the package name. | ||
| - If the `platform.protocolType` is set to one of possible values `'Ssl3' | 'Tls' | 'Tls11' | 'Tls12' | 'Tls13'` all external modules(Added through Import-Module in the code) will be downloaded using the selected encryption protcol, otherwise the system default is used. | ||
|
|
||
| ### Templates | ||
| There are three templates: | ||
| * src/template-nodejs ([NodeJs](#nodejs)) | ||
| * src/template-powershell ([Powershell](#powershell)) | ||
| * src/template-python ([Python](#python)) | ||
|
|
||
|
|
||
| Note: you do not need to delete template folders. Any folder starting with `template-` is ignored. | ||
|
|
||
| ### NodeJS | ||
| - `handler.ts` - holds all the logic for the action | ||
| - `tsconfig.json` - used by typescript to compile the code during `mvn package`, since rootDirs and srcDirs are dynamic, there are | ||
| placeholders in this file. **do not modify** | ||
|
|
||
| > Dependencies | ||
| > | ||
| > NodeJS' dependencies are defined in the `package.json` file in the `dependencies` property. Specify only dependencies to | ||
| > your code, there are no mandatory dependencies as well as no default ones. | ||
| ### Python | ||
| - `handler.py` - holds all the logic for the action | ||
| - `requirements.txt` - holds dependency information e.g. requirements.txt: | ||
| ```python | ||
| requests==2.23.0 | ||
| ``` | ||
|
|
||
| > Dependencies | ||
| > | ||
| > These follow the standard python `requirements.txt` structure. No default or mandatory dependencies. [More Info](https://learnpython.com/blog/python-requirements-file/) | ||
|
|
||
| ### Powershell | ||
| - `handler.ps1` - holds all the logic for the action | ||
|
|
1 change: 1 addition & 0 deletions
1
docs/versions/v2.35.0/Components/Archetypes/Polyglot/General/Troubleshooting.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| [//]: # (Finish with some troubleshooting tips, when any error are encountered and fixed for future issues) |
11 changes: 11 additions & 0 deletions
11
docs/versions/v2.35.0/Components/Archetypes/Polyglot/General/Usage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Usage | ||
|
|
||
| ## Overview | ||
| Polyglot archetype just like any other archetype utilizes the `vrealize:push` to package and deploy the artifacts. | ||
|
|
||
| ## Table Of Contents: | ||
| 1. [Command](#command) | ||
|
|
||
| ### Command | ||
|
|
||
| `mvn clean package vrealize:push -Penvironment_profile` |
13 changes: 13 additions & 0 deletions
13
docs/versions/v2.35.0/Components/Archetypes/Polyglot/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Polyglot | ||
| The polyglot archetype is an archetype that allows you to push "polyglot" actions to vRO and vRA ( like powershell, python, nodejs ) | ||
|
|
||
| ## Overview | ||
| The polyglot archetype is used to push multiple of these actions at the same time in a single package. | ||
|
|
||
| ## Navigation: | ||
| - Getting Started | ||
| - [Project Structure](./General/Project Structure.md) | ||
| - [New Project](./General/New Project.md) | ||
| - [Usage](./General/Usage.md) | ||
| - [Troubleshooting](./General/Troubleshooting.md) | ||
|
|
91 changes: 91 additions & 0 deletions
91
docs/versions/v2.35.0/Components/Archetypes/typescript/Components/Actions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # Actions | ||
| vRO Actions, supported types and how to use them inside the Typescript Archetype | ||
|
|
||
| ## Overview | ||
| vRO Actions can essentially be viewed as javascript modules that can be used inside workflows and other actions. This | ||
| is where classes, functions, objects, etc. are defined. | ||
|
|
||
| ## Table Of Contents: | ||
| 1. [Pushing Actions](#pushing-actions) | ||
| 2. [Action Parameters](#action-parameters) | ||
| 3. [Action Return Type](#action-return-type) | ||
| 4. [Examples](#examples) | ||
|
|
||
| ### Pushing Actions | ||
| Actions are pushed when running `mvn clean package vrealize:push`. | ||
|
|
||
| #### Limitations | ||
| - Only actions that are under `PROJECT_ROOT/src` will be pushed to vRO. | ||
| - Only actions that end in `.js` and `.ts` will be pushed. | ||
| - Action name can contain only letters, numbers and the symbols "_" and "$". | ||
| - Action name cannot start with a number. | ||
|
|
||
| ### Action Parameters | ||
| Action Parameters are **NOT** mandatory, but they will be taken into consideration if passed. | ||
|
|
||
| JSDoc Parameters in vRO native actions are used when you want to define the parameter type. It will be taken into | ||
| consideration, otherwise it will be Any. You must follow the way parameter types are defined in vRO. | ||
| The argument name must match the regex: `^[a-zA-Z0-9_$]+$`. If it does not match, the parameter is ignored | ||
|
|
||
| If the action is a typescript one, then typescript hints will be used instead. | ||
|
|
||
| #### Action parameter description | ||
| You can define descriptions per parameter by adding a `-`. | ||
|
|
||
| Example: | ||
| ```javascript | ||
| /** | ||
| * @param {Any} arugment - This is the description | ||
| */ | ||
| ``` | ||
|
|
||
| #### Action parameters with properties | ||
| You can define action parameters with properties like: | ||
| ```javascript | ||
| /** | ||
| * @param {Any} args | ||
| * @param {string} args.url | ||
| */ | ||
| (function (args) { | ||
| return args.url; | ||
| }) | ||
| ``` | ||
| In this example, the args.url will be ignored. | ||
|
|
||
| [JSDoc documentation](https://jsdoc.app/tags-param.html#parameters-with-properties) | ||
|
|
||
| #### Unsupported Parameters | ||
| - Optional `@param {string} [optional=123]` or `@param {string=} optional` | ||
| - Union type `@param {(string|string[])} union` | ||
| - Repeated parameter `@param {...number} num` | ||
|
|
||
| ### Action Return Type | ||
| Action return type is **NOT** mandatory, but it will be taken into consideration if passed. | ||
|
|
||
| You can add `@return` or `@returns` to define the return type of the action, or alternatively if the action is typescript, | ||
| the typescript hints will be used. | ||
|
|
||
| ### Examples: | ||
|
|
||
| #### Native vRO Action | ||
| ```javascript | ||
| /** | ||
| * @param {Any} args | ||
| * @param {number} test | ||
| */ | ||
| (function (args, test, willBeAnyType) { | ||
| return args.url; | ||
| }); | ||
|
|
||
| //...... | ||
|
|
||
| // Will be transpiled to | ||
| return args.url; | ||
| ``` | ||
| In this example: | ||
| - Param `args` of type Any | ||
| - Param `test` of type number | ||
| - Param `willBeAnyType` of type Any | ||
| - Return type: Any | ||
|
|
||
|
|
Oops, something went wrong.