@axway/axway-central-cli 3.13.0 → 3.14.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +94 -94
- package/dist/cli.js +2 -2
- package/dist/commands/apply/index.js +2 -2
- package/dist/commands/completion/index.js +4 -4
- package/dist/commands/config/common/index.js +1 -1
- package/dist/commands/config/index.js +1 -1
- package/dist/commands/config/list.js +1 -1
- package/dist/commands/config/set.js +7 -7
- package/dist/commands/config/unset.js +2 -2
- package/dist/commands/create/agentResource.js +1 -1
- package/dist/commands/create/environment.js +1 -1
- package/dist/commands/create/index.js +2 -2
- package/dist/commands/create/serviceAccount.js +1 -1
- package/dist/commands/delete/index.js +9 -9
- package/dist/commands/edit/environment.js +1 -1
- package/dist/commands/edit/index.js +1 -1
- package/dist/commands/get/index.js +8 -8
- package/dist/commands/install/agents.js +3 -3
- package/dist/commands/install/apigeexAgents.js +1 -1
- package/dist/commands/install/apigeexSaasAgents.js +2 -2
- package/dist/commands/install/awsAgents.js +2 -2
- package/dist/commands/install/awsSaasAgents.js +3 -3
- package/dist/commands/install/azureAgents.js +1 -1
- package/dist/commands/install/azureSaasAgents.js +2 -2
- package/dist/commands/install/backstageAgents.js +1 -1
- package/dist/commands/install/edgeAgents.js +1 -1
- package/dist/commands/install/gitHubSaasAgents.js +2 -2
- package/dist/commands/install/gitLabAgents.js +2 -2
- package/dist/commands/install/graylogAgent.js +2 -2
- package/dist/commands/install/ibmAPIConnectAgents.js +1 -1
- package/dist/commands/install/index.js +2 -2
- package/dist/commands/install/istioAgents.js +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# @axway/axway-central-cli
|
|
2
2
|
|
|
3
|
-
Axway
|
|
3
|
+
Axway Engage CLI package for managing Amplify Engage resources and DevOps operations.
|
|
4
4
|
|
|
5
|
-
**For more documentation and examples please visit [Amplify
|
|
5
|
+
**For more documentation and examples please visit [Amplify Engage CLI documentation portal](https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/cli_central/index.html).**
|
|
6
6
|
|
|
7
7
|
# Installation
|
|
8
8
|
|
|
@@ -12,23 +12,23 @@ Axway Central CLI package for managing Amplify Central resources and DevOps oper
|
|
|
12
12
|
> Terminal shell support: Mac Terminal, Linux Terminal, Windows Command Prompt, Windows PowerShell.
|
|
13
13
|
> Not supported: Cygwin(Windows), Git Bash(Windows).
|
|
14
14
|
|
|
15
|
-
> **Note for existing users**: The "Amplify CLI" core package has been deprecated in favor of the new "Axway CLI" package. The Axway
|
|
15
|
+
> **Note for existing users**: The "Amplify CLI" core package has been deprecated in favor of the new "Axway CLI" package. The Axway Engage CLI supports both the old Amplify CLI core package and the new Axway CLI core package; however, for the purposes of this ReadME and the CLI command help text you may encounter, all commands that previously used the "amplify" keyword now use the "axway" keyword, even though both keywords are supported.
|
|
16
16
|
>
|
|
17
|
-
> Additionally, if you are a current user of the deprecated 'Amplify
|
|
17
|
+
> Additionally, if you are a current user of the deprecated 'Amplify Engage CLI' package, please uninstall it by running
|
|
18
18
|
>
|
|
19
19
|
> ```
|
|
20
20
|
> [sudo] axway pm uninstall @axway/amplify-central-cli
|
|
21
21
|
> ```
|
|
22
22
|
>
|
|
23
|
-
> before following the instructions below to install this 'Axway
|
|
23
|
+
> before following the instructions below to install this 'Axway Engage CLI' package.
|
|
24
24
|
|
|
25
|
-
Assuming you are familiar with [Node.js](https://nodejs.org) and [npm](https://npmjs.com), **ensure you have Node.js >= 12.13.0, and npm >= 6.12.0 installed**. Then, install the [Axway CLI](https://npmjs.com/package/axway), which will give you connectivity to the [Axway Amplify Platform](https://www.axway.com/en/products/amplify). Note that you must first have an account on [https://platform.axway.com](https://platform.axway.com/), and be provisioned in Amplify
|
|
25
|
+
Assuming you are familiar with [Node.js](https://nodejs.org) and [npm](https://npmjs.com), **ensure you have Node.js >= 12.13.0, and npm >= 6.12.0 installed**. Then, install the [Axway CLI](https://npmjs.com/package/axway), which will give you connectivity to the [Axway Amplify Platform](https://www.axway.com/en/products/amplify). Note that you must first have an account on [https://platform.axway.com](https://platform.axway.com/), and be provisioned in Amplify Engage:
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
28
|
$ [sudo] npm install -g axway
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Use the Axway package manager command to install the Axway
|
|
31
|
+
Use the Axway package manager command to install the Axway Engage CLI:
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
34
|
# To install latest available version:
|
|
@@ -61,13 +61,13 @@ Our CLI provides autocompletion support for Bash or Zsh (Linux or MacOS), which
|
|
|
61
61
|
|
|
62
62
|
- **Zsh**
|
|
63
63
|
|
|
64
|
-
The completion script for Zsh can be generated with `axway
|
|
64
|
+
The completion script for Zsh can be generated with `axway engage completion --zsh`. Sourcing the completion script in your shell enables autocomplete for the CLI.
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
67
|
# add autocomplete to zsh for the current shell
|
|
68
|
-
source <(axway
|
|
68
|
+
source <(axway engage completion --zsh)
|
|
69
69
|
# permanently add autocomplete to zsh
|
|
70
|
-
echo "source <(axway
|
|
70
|
+
echo "source <(axway engage completion --zsh)" >> .zshrc
|
|
71
71
|
```
|
|
72
72
|
|
|
73
73
|
If you get an error like `complete:13: command not found: compdef`, then add the following to the beginning of your ~/.zshrc file:
|
|
@@ -81,13 +81,13 @@ Our CLI provides autocompletion support for Bash or Zsh (Linux or MacOS), which
|
|
|
81
81
|
|
|
82
82
|
If you are on a Mac you may need to install the bash-completion script before you begin. To do so run `brew install bash-completion`
|
|
83
83
|
|
|
84
|
-
The completion script for Bash can be generated with `axway
|
|
84
|
+
The completion script for Bash can be generated with `axway engage completion --bash`. Sourcing the completion script in your shell enables autocomplete for the CLI.
|
|
85
85
|
|
|
86
86
|
```bash
|
|
87
87
|
# add autocomplete to bash for the current shell
|
|
88
|
-
source <(axway
|
|
88
|
+
source <(axway engage completion --bash)
|
|
89
89
|
# permanently add autocomplete to bash
|
|
90
|
-
echo "source <(axway
|
|
90
|
+
echo "source <(axway engage completion --bash)" >> .bashrc
|
|
91
91
|
```
|
|
92
92
|
|
|
93
93
|
# Getting started
|
|
@@ -116,14 +116,14 @@ $ axway auth logout -h
|
|
|
116
116
|
# General usage
|
|
117
117
|
|
|
118
118
|
```bash
|
|
119
|
-
USAGE: axway
|
|
119
|
+
USAGE: axway engage <command> [options]
|
|
120
120
|
|
|
121
121
|
Manage APIs, services and publish to the Amplify Marketplace
|
|
122
122
|
|
|
123
|
-
Axway
|
|
123
|
+
Axway ENGAGE COMMANDS:
|
|
124
124
|
apply Update resources from a file
|
|
125
125
|
completion Output shell completion code
|
|
126
|
-
config Configure
|
|
126
|
+
config Configure Engage CLI settings
|
|
127
127
|
create Create one or more resources from a file or stdin
|
|
128
128
|
delete Delete resources
|
|
129
129
|
edit Edit and update resources by using the default editor
|
|
@@ -138,70 +138,70 @@ Axway CENTRAL COMMANDS:
|
|
|
138
138
|
Configuration is saved on disk to allow you to be able to use them across commands.
|
|
139
139
|
|
|
140
140
|
```bash
|
|
141
|
-
axway
|
|
141
|
+
axway engage config <command> [options]
|
|
142
142
|
|
|
143
143
|
CONFIG COMMANDS:
|
|
144
|
-
list View
|
|
145
|
-
set Set
|
|
144
|
+
list View Engage CLI settings
|
|
145
|
+
set Set Engage CLI settings
|
|
146
146
|
```
|
|
147
147
|
|
|
148
148
|
### Region configuration
|
|
149
149
|
|
|
150
|
-
Region configuration identifies the Amplify
|
|
150
|
+
Region configuration identifies the Amplify Engage instance to whose servers you want to send your requests. Your current authenticated account's org setting is used by default (i.e., if your org belongs to the APAC region, it is going to be used automatically).
|
|
151
151
|
|
|
152
152
|
You can always override the current region setting by configuring CLI with the following command (possible values are `US`, `EU` or `AP`):
|
|
153
153
|
|
|
154
154
|
```bash
|
|
155
155
|
# to point CLI to EU region:
|
|
156
|
-
axway
|
|
156
|
+
axway engage config set --region=EU
|
|
157
157
|
# to point CLI to US region:
|
|
158
|
-
axway
|
|
158
|
+
axway engage config set --region=US
|
|
159
159
|
# to point CLI to APAC region:
|
|
160
|
-
axway
|
|
160
|
+
axway engage config set --region=AP
|
|
161
161
|
```
|
|
162
162
|
|
|
163
163
|
Or by adding optional `--region=<value>` flag with any command:
|
|
164
164
|
|
|
165
165
|
```bash
|
|
166
|
-
axway
|
|
166
|
+
axway engage get environments --region=EU
|
|
167
167
|
```
|
|
168
168
|
|
|
169
169
|
### Account configuration
|
|
170
170
|
|
|
171
|
-
In general, it is not needed to manipulate the `account` configuration. CLI should be able to detect the current default account. However, if you want to use a specific account Axway
|
|
171
|
+
In general, it is not needed to manipulate the `account` configuration. CLI should be able to detect the current default account. However, if you want to use a specific account Axway Engage CLI allows you to provide `--account` with every command you run to override your `auth.defaultAccount` config in Axway CLI (you can check its value by running `axway config list` or `axway config get auth.defaultAccount`):
|
|
172
172
|
|
|
173
173
|
```bash
|
|
174
|
-
axway
|
|
174
|
+
axway engage get environments --account=<Desired account name>
|
|
175
175
|
# for example:
|
|
176
|
-
axway
|
|
176
|
+
axway engage get environments --account=amplify-cli:johndoe@axway.com
|
|
177
177
|
```
|
|
178
178
|
|
|
179
179
|
You can also achieve same goal by running `axway config set auth.defaultAccount <desired account name>` command when needed. Keep in mind that this value is set automatically when you login to the platform using CLI.
|
|
180
180
|
|
|
181
181
|
### Extensions:
|
|
182
182
|
|
|
183
|
-
You can set up extensions to the Axway
|
|
183
|
+
You can set up extensions to the Axway Engage CLI. Extensions can be a npm package, a Javascript file or even an executable. Once set, you would be able to use these extensions as commands from within the Axway Engage CLI.
|
|
184
184
|
|
|
185
|
-
Tip: You can create extensions using our [cli-kit](https://www.npmjs.com/package/cli-kit) which is the same framework used by Axway
|
|
185
|
+
Tip: You can create extensions using our [cli-kit](https://www.npmjs.com/package/cli-kit) which is the same framework used by Axway Engage CLI.
|
|
186
186
|
|
|
187
187
|
```bash
|
|
188
|
-
axway
|
|
188
|
+
axway engage config set extensions.<name> <path_to_executable>
|
|
189
189
|
```
|
|
190
190
|
|
|
191
191
|
#### setting extension example:
|
|
192
192
|
|
|
193
193
|
```bash
|
|
194
194
|
# set the name and the path to your extension
|
|
195
|
-
axway
|
|
196
|
-
# my-extension can then be used as a command from the Axway
|
|
197
|
-
axway
|
|
195
|
+
axway engage config set extensions.my-extension '~/myExtension'
|
|
196
|
+
# my-extension can then be used as a command from the Axway Engage CLI
|
|
197
|
+
axway engage my-extension ...
|
|
198
198
|
```
|
|
199
199
|
|
|
200
200
|
### Proxy configuration:
|
|
201
201
|
|
|
202
202
|
**_Note: Please always check Axway CLI docs for the latest proxy configuration instructions._**
|
|
203
203
|
|
|
204
|
-
Axway
|
|
204
|
+
Axway Engage CLI relies on the Axway CLI configuration for proxy support. To set the proxy URL:
|
|
205
205
|
|
|
206
206
|
```bash
|
|
207
207
|
axway config set network.httpProxy http://proxy.int:9090
|
|
@@ -218,7 +218,7 @@ axway config set network.strictSSL false
|
|
|
218
218
|
You can see all your saved configuration using:
|
|
219
219
|
|
|
220
220
|
```bash
|
|
221
|
-
axway
|
|
221
|
+
axway engage config ls
|
|
222
222
|
```
|
|
223
223
|
|
|
224
224
|
---
|
|
@@ -239,7 +239,7 @@ You can query for more than one resource if using comma-separated resources in t
|
|
|
239
239
|
|
|
240
240
|
Querying for multiple resources will display multiple result tables, one result table for each resource you fetch.
|
|
241
241
|
|
|
242
|
-
To see the list of all available resources on the server run `axway
|
|
242
|
+
To see the list of all available resources on the server run `axway engage get`, for example (not an actual list, always check the CLI for the latest):
|
|
243
243
|
|
|
244
244
|
```
|
|
245
245
|
RESOURCE SHORT NAMES RESOURCE KIND SCOPED SCOPE KIND RESOURCE GROUP
|
|
@@ -297,12 +297,12 @@ Note: Using the --query flag will override any --title, --tag or --attribute fla
|
|
|
297
297
|
### get usage
|
|
298
298
|
|
|
299
299
|
```text
|
|
300
|
-
USAGE: axway
|
|
300
|
+
USAGE: axway engage get [options] [<args...>]
|
|
301
301
|
|
|
302
302
|
Display one or many resources.
|
|
303
303
|
|
|
304
304
|
GET ARGUMENTS:
|
|
305
|
-
args... Command arguments, run "axway
|
|
305
|
+
args... Command arguments, run "axway engage get" to see the examples
|
|
306
306
|
|
|
307
307
|
GET OPTIONS:
|
|
308
308
|
--attribute [key=value] Attribute in key=value pair format to filter by
|
|
@@ -322,55 +322,55 @@ GET OPTIONS:
|
|
|
322
322
|
|
|
323
323
|
```bash
|
|
324
324
|
# get all environments
|
|
325
|
-
axway
|
|
325
|
+
axway engage get envs
|
|
326
326
|
# get all environments in yaml format
|
|
327
|
-
axway
|
|
327
|
+
axway engage get environments -o yaml
|
|
328
328
|
# get environment by Resource/Common name in json format
|
|
329
|
-
axway
|
|
329
|
+
axway engage get env myenv -o json
|
|
330
330
|
# get all webhooks
|
|
331
|
-
axway
|
|
331
|
+
axway engage get webhooks
|
|
332
332
|
# get all webhooks by Short Name
|
|
333
|
-
axway
|
|
333
|
+
axway engage get webh
|
|
334
334
|
# get all webhooks and apiservices by Short Name
|
|
335
|
-
axway
|
|
335
|
+
axway engage get webh,apis
|
|
336
336
|
# get all environments and api services
|
|
337
|
-
axway
|
|
337
|
+
axway engage get envs,apisvc
|
|
338
338
|
# get environment and apiservice which matches a Resource/Common Name in a specified scope(scope is required ater -s flag) in json format
|
|
339
|
-
axway
|
|
339
|
+
axway engage get env,apisvc commonname -s env1 -o json
|
|
340
340
|
# get apiservice with name "testsvc" in the scope "Environment" with name "testenv"
|
|
341
|
-
axway
|
|
341
|
+
axway engage get apisvc testsvc -s Environment/testenv
|
|
342
342
|
# get product with name "testproduct" with all available language information and output in json
|
|
343
|
-
axway
|
|
343
|
+
axway engage get products testproduct --language="*" -o json
|
|
344
344
|
# get assets with titles that start with "a"
|
|
345
|
-
axway
|
|
345
|
+
axway engage get assets -q "title==a*"
|
|
346
346
|
# get assets with titles that start with a or i
|
|
347
|
-
axway
|
|
347
|
+
axway engage get assets -q "title==a* or title==i*"
|
|
348
348
|
# get assets with tags that match tag1 or tag2
|
|
349
|
-
axway
|
|
349
|
+
axway engage get assets -q "tags=in=(tag1,tag2)"
|
|
350
350
|
# get assets and filter the list to assets that have a specific title "test"
|
|
351
|
-
axway
|
|
351
|
+
axway engage get assets --title test
|
|
352
352
|
# get assets and filter the list to assets that have a specific tag "tag1"
|
|
353
|
-
axway
|
|
353
|
+
axway engage get assets --tag tag1
|
|
354
354
|
# get assets and filter the list to assets that have a specific attribute "location=arizona"
|
|
355
|
-
axway
|
|
355
|
+
axway engage get assets --attribute location=arizona
|
|
356
356
|
# get assets and filter the list with a combination of title, tag and attribute filters
|
|
357
|
-
axway
|
|
357
|
+
axway engage get assets --title test --tag tag1 --attribute location=arizona
|
|
358
358
|
# To get a product with name "test-product" with French language translation if available in YAML format
|
|
359
|
-
axway
|
|
359
|
+
axway engage get products test-product --language="fr-fr" -o yaml
|
|
360
360
|
# To get a product with name "test-product" with German language translation if available in YAML format
|
|
361
|
-
axway
|
|
361
|
+
axway engage get products test-product --language="de-de" -o yaml
|
|
362
362
|
# To get a product with name "test-product" with US English language translation if available in YAML format
|
|
363
|
-
axway
|
|
363
|
+
axway engage get products test-product --language="en-us" -o yaml
|
|
364
364
|
# To get a product with name "test-product" with Portugal language translation if available in YAML format
|
|
365
|
-
axway
|
|
365
|
+
axway engage get products test-product --language="pt-br" -o yaml
|
|
366
366
|
# To get a stage with name "demo-stage" with the French language translation in JSON format
|
|
367
|
-
axway
|
|
367
|
+
axway engage get stages demo-stage --languageDefinition="fr-fr" -o json
|
|
368
368
|
# To get a stage with name "demo-stage" with the US English language translation in JSON format
|
|
369
|
-
axway
|
|
369
|
+
axway engage get stages demo-stage --languageDefinition="en-us" -o json
|
|
370
370
|
# To get a stage with name "demo-stage" with the German language translation in JSON format
|
|
371
|
-
axway
|
|
371
|
+
axway engage get stages demo-stage --languageDefinition="de-de" -o json
|
|
372
372
|
# To get a stage with name "demo-stage" with the Portugese language translation in JSON format
|
|
373
|
-
axway
|
|
373
|
+
axway engage get stages demo-stage --languageDefinition="pt-br" -o json
|
|
374
374
|
```
|
|
375
375
|
|
|
376
376
|
---
|
|
@@ -378,7 +378,7 @@ axway central get stages demo-stage --languageDefinition="pt-br" -o json
|
|
|
378
378
|
## CREATE
|
|
379
379
|
|
|
380
380
|
```text
|
|
381
|
-
USAGE: axway
|
|
381
|
+
USAGE: axway engage create <command> [options]
|
|
382
382
|
|
|
383
383
|
Create one or more resources from a file or stdin
|
|
384
384
|
|
|
@@ -398,7 +398,7 @@ CREATE OPTIONS:
|
|
|
398
398
|
### create: multiple resources from a file
|
|
399
399
|
|
|
400
400
|
```text
|
|
401
|
-
USAGE: axway
|
|
401
|
+
USAGE: axway engage create -f <path_to_file>
|
|
402
402
|
```
|
|
403
403
|
|
|
404
404
|
### create: specific resource by name
|
|
@@ -406,7 +406,7 @@ USAGE: axway central create -f <path_to_file>
|
|
|
406
406
|
**_Note: Only environments are currently available for this command._**
|
|
407
407
|
|
|
408
408
|
```text
|
|
409
|
-
USAGE: axway
|
|
409
|
+
USAGE: axway engage create environment [options] <name>
|
|
410
410
|
|
|
411
411
|
Create an environment with the specified name
|
|
412
412
|
|
|
@@ -426,13 +426,13 @@ CREATE OPTIONS:
|
|
|
426
426
|
|
|
427
427
|
```bash
|
|
428
428
|
# create new environment with "newenv" name
|
|
429
|
-
axway
|
|
429
|
+
axway engage create env newenv
|
|
430
430
|
# create new environment with "newenv" name and output result in yaml
|
|
431
|
-
axway
|
|
431
|
+
axway engage create environment newenv -o yaml
|
|
432
432
|
# create multiple resources from file
|
|
433
|
-
axway
|
|
433
|
+
axway engage create -f ./some/folder/resources.yaml
|
|
434
434
|
# create an agent resource
|
|
435
|
-
axway
|
|
435
|
+
axway engage create agent-resource
|
|
436
436
|
```
|
|
437
437
|
|
|
438
438
|
---
|
|
@@ -444,7 +444,7 @@ The resource name must be specified in the file. This resource will be created i
|
|
|
444
444
|
> **Note:** apply command removes the resourceVersion from metadata of the resource to avoid conflict of resource creation
|
|
445
445
|
|
|
446
446
|
```text
|
|
447
|
-
USAGE: axway
|
|
447
|
+
USAGE: axway engage apply [options]
|
|
448
448
|
|
|
449
449
|
Update resources from a file
|
|
450
450
|
|
|
@@ -463,13 +463,13 @@ APPLY OPTIONS:
|
|
|
463
463
|
|
|
464
464
|
```bash
|
|
465
465
|
# create or update multiple resources from file
|
|
466
|
-
axway
|
|
466
|
+
axway engage apply -f ./some/folder/resources.yaml
|
|
467
467
|
# create or update multiple resources from file and output results in YAML format
|
|
468
|
-
axway
|
|
468
|
+
axway engage apply -f ./some/folder/resources.json -o yaml
|
|
469
469
|
# only update 1 language "en-us" for multiple resources from file
|
|
470
|
-
axway
|
|
470
|
+
axway engage apply -f ./some/folder/resources.yaml --language en-us
|
|
471
471
|
# only update 1 subresource named "state" for multiple resources from file
|
|
472
|
-
axway
|
|
472
|
+
axway engage apply -f ./some/folder/resources.yaml --subresource state
|
|
473
473
|
```
|
|
474
474
|
|
|
475
475
|
---
|
|
@@ -496,15 +496,15 @@ state: state value
|
|
|
496
496
|
|
|
497
497
|
Delete resources by type and name or by filename.
|
|
498
498
|
When deleting a resource by its name, if the desired resource type is scoped, you will need to specify the scope name by providing `-s, --scope (or <scope kind>/<scope name>)` flag. If the resource might exist in multiple scopes a prompt will be displayed to prevent the unintended deletion of multiple resources. You can skip this prompt by providing `-y, --yes`flag.
|
|
499
|
-
To see the list of all available resources on the server run `axway
|
|
499
|
+
To see the list of all available resources on the server run `axway engage delete`.
|
|
500
500
|
|
|
501
501
|
```text
|
|
502
|
-
USAGE: axway
|
|
502
|
+
USAGE: axway engage delete [options] [<args...>]
|
|
503
503
|
|
|
504
504
|
Delete resources
|
|
505
505
|
|
|
506
506
|
DELETE ARGUMENTS:
|
|
507
|
-
args... Command arguments, run "axway
|
|
507
|
+
args... Command arguments, run "axway engage delete" to see the examples
|
|
508
508
|
|
|
509
509
|
DELETE OPTIONS:
|
|
510
510
|
--account [value] Override your default account config
|
|
@@ -521,21 +521,21 @@ DELETE OPTIONS:
|
|
|
521
521
|
|
|
522
522
|
```bash
|
|
523
523
|
# delete environment by name
|
|
524
|
-
axway
|
|
524
|
+
axway engage delete environment newenv
|
|
525
525
|
# delete api service by name (a scoped resource)
|
|
526
|
-
axway
|
|
526
|
+
axway engage delete apisvc someapisvc -s newenv
|
|
527
527
|
# delete document with name "somedoc" in all scopes named "somescope" without confirmation prompt
|
|
528
|
-
axway
|
|
528
|
+
axway engage delete docs somedoc -s somescope -y
|
|
529
529
|
# delete document with name "somedoc" in all scope "AssetRelease" named "somescope"
|
|
530
|
-
axway
|
|
530
|
+
axway engage delete docs somedoc -s AssetRelease/somescope -y
|
|
531
531
|
# delete all resources specified in the file
|
|
532
|
-
axway
|
|
532
|
+
axway engage delete -f ./some/folder/resources.yaml
|
|
533
533
|
# force delete environment by name with a prompt
|
|
534
|
-
axway
|
|
534
|
+
axway engage delete environment newenv --forceDelete
|
|
535
535
|
# force delete API service by name (a scoped resource) with a prompt
|
|
536
|
-
axway
|
|
536
|
+
axway engage delete apisvc someapisvc -s newenv --forceDelete
|
|
537
537
|
# force delete all resources specified in the file without a prompt
|
|
538
|
-
axway
|
|
538
|
+
axway engage delete -f ./some/folder/resources.yaml --forceDelete --yes
|
|
539
539
|
```
|
|
540
540
|
|
|
541
541
|
---
|
|
@@ -543,7 +543,7 @@ axway central delete -f ./some/folder/resources.yaml --forceDelete --yes
|
|
|
543
543
|
## EDIT
|
|
544
544
|
|
|
545
545
|
```text
|
|
546
|
-
USAGE: axway
|
|
546
|
+
USAGE: axway engage edit <command> [options]
|
|
547
547
|
|
|
548
548
|
Edit and update resources by using the default editor
|
|
549
549
|
|
|
@@ -562,7 +562,7 @@ EDIT OPTIONS:
|
|
|
562
562
|
_Using "environment" as an example._
|
|
563
563
|
|
|
564
564
|
```text
|
|
565
|
-
USAGE: axway
|
|
565
|
+
USAGE: axway engage edit environment [options] <name>
|
|
566
566
|
|
|
567
567
|
Edit an environment with the specified name.
|
|
568
568
|
|
|
@@ -580,15 +580,15 @@ EDIT OPTIONS:
|
|
|
580
580
|
|
|
581
581
|
```bash
|
|
582
582
|
# delete environment by name
|
|
583
|
-
axway
|
|
583
|
+
axway engage edit environment newenv
|
|
584
584
|
```
|
|
585
585
|
|
|
586
586
|
---
|
|
587
587
|
|
|
588
|
-
## INSTALL (axway
|
|
588
|
+
## INSTALL (axway engage / platform resources)
|
|
589
589
|
|
|
590
590
|
```text
|
|
591
|
-
USAGE: axway
|
|
591
|
+
USAGE: axway engage install <command> [options] [<args...>]
|
|
592
592
|
|
|
593
593
|
Install additional platform resources
|
|
594
594
|
|
|
@@ -596,7 +596,7 @@ INSTALL COMMANDS:
|
|
|
596
596
|
agents Install Amplify API Gateway / Amazon API Gateway / Azure API Gateway / Istio / Apigee X Gateway / GitHub / GitLab / Kafka / SwaggerHub
|
|
597
597
|
|
|
598
598
|
INSTALL ARGUMENTS:
|
|
599
|
-
args... Command arguments, run "axway
|
|
599
|
+
args... Command arguments, run "axway engage install" to see the examples
|
|
600
600
|
|
|
601
601
|
INSTALL OPTIONS:
|
|
602
602
|
--account [value] Override your default account config
|
|
@@ -607,7 +607,7 @@ INSTALL OPTIONS:
|
|
|
607
607
|
### install: agents configuration
|
|
608
608
|
|
|
609
609
|
```text
|
|
610
|
-
USAGE: axway
|
|
610
|
+
USAGE: axway engage install agents [options]
|
|
611
611
|
|
|
612
612
|
Amplify API Gateway / Amazon API Gateway / Azure API Gateway / Istio / Apigee X Gateway / GitHub / GitLab / Kafka / SwaggerHub
|
|
613
613
|
|
|
@@ -621,7 +621,7 @@ INSTALL OPTIONS:
|
|
|
621
621
|
|
|
622
622
|
```bash
|
|
623
623
|
# install agent configuration in interactive mode
|
|
624
|
-
axway
|
|
624
|
+
axway engage install agents
|
|
625
625
|
```
|
|
626
626
|
|
|
627
627
|
---
|
package/dist/cli.js
CHANGED
|
@@ -33,8 +33,8 @@ const extensions = [...Object.values((0, _fsExtra.readJsonSync)(_utils.configFil
|
|
|
33
33
|
|
|
34
34
|
// cliParams export only needed for "completion" command and its testing
|
|
35
35
|
const cliParams = exports.cliParams = {
|
|
36
|
-
title: 'Axway
|
|
37
|
-
name: '
|
|
36
|
+
title: 'Axway Engage CLI',
|
|
37
|
+
name: 'engage',
|
|
38
38
|
banner: '',
|
|
39
39
|
version,
|
|
40
40
|
commands: {
|
|
@@ -15,7 +15,7 @@ var _utils = require("../../common/utils");
|
|
|
15
15
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
16
16
|
const {
|
|
17
17
|
log
|
|
18
|
-
} = (0, _snooplogg.default)('
|
|
18
|
+
} = (0, _snooplogg.default)('engage: create');
|
|
19
19
|
const action = async ({
|
|
20
20
|
argv,
|
|
21
21
|
console
|
|
@@ -59,7 +59,7 @@ const action = async ({
|
|
|
59
59
|
if (!yes && isMissingName) {
|
|
60
60
|
render.stopSpin();
|
|
61
61
|
if ((await (0, _basicPrompts.askList)({
|
|
62
|
-
msg: `As your file contains resources with missing logical names, their logical names will be autogenerated. \nRun ${_chalk.default.cyan('axway
|
|
62
|
+
msg: `As your file contains resources with missing logical names, their logical names will be autogenerated. \nRun ${_chalk.default.cyan('axway engage apply -f <filepath> -o [yaml|json] -y > <output filepath>')} to capture the resource(s) with the autogenerated logical name(s) so you can use them again. \nNOTE: To suppress this prompt in the future, please use the '-y' flag. \nWould you like to continue *without* capturing the resource names in a new file?`,
|
|
63
63
|
choices: _types.YesNoChoices,
|
|
64
64
|
default: _types.YesNo.Yes
|
|
65
65
|
})) === _types.YesNo.No) process.exit(1);
|
|
@@ -12,7 +12,7 @@ _amplify_central_completions()
|
|
|
12
12
|
local state
|
|
13
13
|
_arguments -C \\
|
|
14
14
|
{-f,--file=}':: :_files' \\
|
|
15
|
-
'1: :(
|
|
15
|
+
'1: :(engage)' \\
|
|
16
16
|
'*: :->cmd'
|
|
17
17
|
|
|
18
18
|
case $state in
|
|
@@ -34,10 +34,10 @@ _amplify_central_completions()
|
|
|
34
34
|
local cur="\${COMP_WORDS[COMP_CWORD]}"
|
|
35
35
|
local prev="\${COMP_WORDS[COMP_CWORD-1]}"
|
|
36
36
|
local twoPrev="\${COMP_WORDS[COMP_CWORD-2]}"
|
|
37
|
-
local options=$(${coreCliCmd}
|
|
37
|
+
local options=$(${coreCliCmd} engage completion --get-completions "\${COMP_WORDS[@]}")
|
|
38
38
|
|
|
39
39
|
case $COMP_CWORD in
|
|
40
|
-
1) COMPREPLY=("
|
|
40
|
+
1) COMPREPLY=("engage");;
|
|
41
41
|
2) COMPREPLY=($(compgen -W "$options" -- "$cur"));;
|
|
42
42
|
3) compopt +o default; COMPREPLY=();; # disable file completion
|
|
43
43
|
*)
|
|
@@ -69,7 +69,7 @@ const action = ({
|
|
|
69
69
|
bash
|
|
70
70
|
} = argv;
|
|
71
71
|
if (getCompletions) {
|
|
72
|
-
if (args[0] === coreCliCmd && args[1] === '
|
|
72
|
+
if (args[0] === coreCliCmd && args[1] === 'engage' && args.length <= 3) {
|
|
73
73
|
/** get core commands from CLI-kit params */
|
|
74
74
|
Object.keys(_cli.cliParams.commands).forEach(cmd => console.log(cmd));
|
|
75
75
|
}
|
|
@@ -10,7 +10,7 @@ var _utils = require("../../../common/utils");
|
|
|
10
10
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
11
11
|
const {
|
|
12
12
|
log
|
|
13
|
-
} = (0, _snooplogg.default)('
|
|
13
|
+
} = (0, _snooplogg.default)('engage: config: common');
|
|
14
14
|
const readConfig = async () => {
|
|
15
15
|
log(`Reading config: ${_utils.configFile}`);
|
|
16
16
|
try {
|
|
@@ -13,7 +13,7 @@ var _common = require("./common");
|
|
|
13
13
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
14
14
|
const {
|
|
15
15
|
log
|
|
16
|
-
} = (0, _cliKit.snooplogg)('
|
|
16
|
+
} = (0, _cliKit.snooplogg)('engage: config: set');
|
|
17
17
|
const action = async ({
|
|
18
18
|
argv,
|
|
19
19
|
console
|
|
@@ -22,8 +22,8 @@ const action = async ({
|
|
|
22
22
|
const isValidRootConfig = argv.baseUrl || argv.clientId || argv.region || argv.platform || argv.apicDeployment;
|
|
23
23
|
const isValidExtension = ((_argv$name = argv.name) === null || _argv$name === void 0 ? void 0 : _argv$name.startsWith(`${_types.ConfigTypes.EXTENSIONS}.`)) && argv.value;
|
|
24
24
|
if (!isValidRootConfig && !isValidExtension) {
|
|
25
|
-
log((0, _cliKit.chalk)`{magenta Allowed
|
|
26
|
-
throw Error(` Allowed
|
|
25
|
+
log((0, _cliKit.chalk)`{magenta Allowed engage config values weren't provided. Exiting...}`);
|
|
26
|
+
throw Error(` Allowed engage config values weren't provided`);
|
|
27
27
|
}
|
|
28
28
|
if (argv.clientId) {
|
|
29
29
|
log(`Unsupported values received`);
|
|
@@ -43,7 +43,7 @@ const action = async ({
|
|
|
43
43
|
// verify passed value
|
|
44
44
|
const parsedValue = String(argv.region).toUpperCase();
|
|
45
45
|
if (!(parsedValue in _types.Regions)) {
|
|
46
|
-
throw Error(`"--region" value is not correct, please provide one of: ${Object.values(_types.Regions).sort().join(', ')}. For example: "axway
|
|
46
|
+
throw Error(`"--region" value is not correct, please provide one of: ${Object.values(_types.Regions).sort().join(', ')}. For example: "axway engage config set --region=US"`);
|
|
47
47
|
}
|
|
48
48
|
log(`Writing ${_types.ConfigTypes.REGION}`);
|
|
49
49
|
config[_types.ConfigTypes.REGION] = parsedValue;
|
|
@@ -51,7 +51,7 @@ const action = async ({
|
|
|
51
51
|
if (argv.platform) {
|
|
52
52
|
const parsedValue = String(argv.platform).toLowerCase();
|
|
53
53
|
if (!(parsedValue in _types.Platforms)) {
|
|
54
|
-
throw Error(`"--platform" value is not correct, please provide one of: ${Object.values(_types.Platforms).sort().join(', ')}. For example: "axway
|
|
54
|
+
throw Error(`"--platform" value is not correct, please provide one of: ${Object.values(_types.Platforms).sort().join(', ')}. For example: "axway engage config set --platform=staging"`);
|
|
55
55
|
}
|
|
56
56
|
log(`Writing ${_types.ConfigTypes.PLATFORM}`);
|
|
57
57
|
config[_types.ConfigTypes.PLATFORM] = parsedValue;
|
|
@@ -59,7 +59,7 @@ const action = async ({
|
|
|
59
59
|
if (argv.apicDeployment) {
|
|
60
60
|
log(`Writing ${_types.ConfigTypes.APIC_DEPLOYMENT}`);
|
|
61
61
|
if (!Object.values(_types.APICDeployments).includes(argv.apicDeployment)) {
|
|
62
|
-
throw Error(`"--apic-deployment" value is not correct, please provide one of: ${Object.values(_types.APICDeployments).sort().join(', ')}. For example: "axway
|
|
62
|
+
throw Error(`"--apic-deployment" value is not correct, please provide one of: ${Object.values(_types.APICDeployments).sort().join(', ')}. For example: "axway engage config set --apic-deployment=staging"`);
|
|
63
63
|
}
|
|
64
64
|
config[_types.ConfigTypes.APIC_DEPLOYMENT] = argv.apicDeployment;
|
|
65
65
|
}
|
|
@@ -79,7 +79,7 @@ const action = async ({
|
|
|
79
79
|
};
|
|
80
80
|
const setCommand = exports.setCommand = {
|
|
81
81
|
action,
|
|
82
|
-
desc: 'Set
|
|
82
|
+
desc: 'Set Engage CLI settings',
|
|
83
83
|
options: {
|
|
84
84
|
// TODO: client-id is no longer supported keeping for some time for validation purposes
|
|
85
85
|
// config rework is going to happen: https://jira.axway.com/browse/APIGOV-19737
|
|
@@ -10,7 +10,7 @@ var _Renderer = _interopRequireDefault(require("../../common/Renderer"));
|
|
|
10
10
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
11
11
|
const {
|
|
12
12
|
log
|
|
13
|
-
} = (0, _cliKit.snooplogg)('
|
|
13
|
+
} = (0, _cliKit.snooplogg)('engage: config: unset');
|
|
14
14
|
const action = async ({
|
|
15
15
|
argv,
|
|
16
16
|
console
|
|
@@ -38,7 +38,7 @@ const action = async ({
|
|
|
38
38
|
};
|
|
39
39
|
const unset = exports.unset = {
|
|
40
40
|
action,
|
|
41
|
-
desc: 'Unset Axway
|
|
41
|
+
desc: 'Unset Axway engage configuration values',
|
|
42
42
|
args: [{
|
|
43
43
|
name: 'keys',
|
|
44
44
|
desc: 'Configuration values to unset (can be comma-separated values)',
|
|
@@ -15,7 +15,7 @@ var _basicPrompts = require("../../common/basicPrompts");
|
|
|
15
15
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
16
16
|
const {
|
|
17
17
|
log
|
|
18
|
-
} = (0, _snooplogg.default)('
|
|
18
|
+
} = (0, _snooplogg.default)('engage: create: agent-resource');
|
|
19
19
|
const action = async ({
|
|
20
20
|
argv,
|
|
21
21
|
console
|
|
@@ -11,7 +11,7 @@ var _resultsRenderers = require("../../common/resultsRenderers");
|
|
|
11
11
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
12
12
|
const {
|
|
13
13
|
log
|
|
14
|
-
} = (0, _snooplogg.default)('
|
|
14
|
+
} = (0, _snooplogg.default)('engage: create: environment');
|
|
15
15
|
const action = async ({
|
|
16
16
|
argv,
|
|
17
17
|
console
|
|
@@ -18,7 +18,7 @@ var _chalk = _interopRequireDefault(require("chalk"));
|
|
|
18
18
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
19
19
|
const {
|
|
20
20
|
log
|
|
21
|
-
} = (0, _snooplogg.default)('
|
|
21
|
+
} = (0, _snooplogg.default)('engage: create');
|
|
22
22
|
const action = async ({
|
|
23
23
|
argv,
|
|
24
24
|
console
|
|
@@ -64,7 +64,7 @@ const action = async ({
|
|
|
64
64
|
if (!yes && isMissingName) {
|
|
65
65
|
render.stopSpin();
|
|
66
66
|
if ((await (0, _basicPrompts.askList)({
|
|
67
|
-
msg: `As your file contains resources with missing logical names, their logical names will be autogenerated. \nRun ${_chalk.default.cyan('axway
|
|
67
|
+
msg: `As your file contains resources with missing logical names, their logical names will be autogenerated. \nRun ${_chalk.default.cyan('axway engage create -f <filepath> -o [yaml|json] -y > <output filepath>')} to capture the resource(s) with the autogenerated logical name(s) so you can use them again. \nNOTE: To suppress this prompt in the future, please use the '-y' flag. \nWould you like to continue *without* capturing the resource names in a new file?`,
|
|
68
68
|
choices: _types.YesNoChoices,
|
|
69
69
|
default: _types.YesNo.Yes
|
|
70
70
|
})) === _types.YesNo.No) process.exit(1);
|
|
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports.serviceAccount = void 0;
|
|
7
7
|
const action = async ({}) => {
|
|
8
|
-
throw new Error('Creating a service account via "
|
|
8
|
+
throw new Error('Creating a service account via "engage" is no longer supported. ' + 'Use the "axway" CLI instead. ' + 'Example: "axway service-account create [options]"');
|
|
9
9
|
};
|
|
10
10
|
const serviceAccount = exports.serviceAccount = {
|
|
11
11
|
aliases: ['service account', 'service-account', 'serviceaccount'],
|
|
@@ -15,7 +15,7 @@ var _utils = require("../../common/utils");
|
|
|
15
15
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
16
16
|
const {
|
|
17
17
|
log
|
|
18
|
-
} = (0, _snooplogg.default)('
|
|
18
|
+
} = (0, _snooplogg.default)('engage: delete');
|
|
19
19
|
const action = async ({
|
|
20
20
|
argv,
|
|
21
21
|
console
|
|
@@ -49,8 +49,8 @@ const action = async ({
|
|
|
49
49
|
if (file && args.length) {
|
|
50
50
|
render.error('Error: Invalid command arguments, please provide a file path or resource type and name.');
|
|
51
51
|
console.log(`\nUSAGE:
|
|
52
|
-
To delete resources by filenames:\t"axway
|
|
53
|
-
To delete a single resource:\t\t"axway
|
|
52
|
+
To delete resources by filenames:\t"axway engage delete -f/--file <path>
|
|
53
|
+
To delete a single resource:\t\t"axway engage delete <Resource> <Name>"`);
|
|
54
54
|
process.exit(1);
|
|
55
55
|
}
|
|
56
56
|
try {
|
|
@@ -58,18 +58,18 @@ To delete a single resource:\t\t"axway central delete <Resource> <Name>"`);
|
|
|
58
58
|
await defsManager.init();
|
|
59
59
|
const scope = (0, _utils.parseScopeParam)(argv.scope);
|
|
60
60
|
if (!file && !args.length) {
|
|
61
|
-
// user typed just "axway
|
|
61
|
+
// user typed just "axway engage delete"
|
|
62
62
|
render.error('Error: You must specify the type and name of the resource to delete or a file path.');
|
|
63
63
|
console.log(`\nUSAGE:
|
|
64
64
|
|
|
65
65
|
To delete resources by filename:
|
|
66
|
-
${_chalk.default.cyan(`axway
|
|
66
|
+
${_chalk.default.cyan(`axway engage delete -f/--file <path>`)}\n
|
|
67
67
|
To delete a single non-scoped resource:
|
|
68
|
-
${_chalk.default.cyan(`axway
|
|
68
|
+
${_chalk.default.cyan(`axway engage delete <Resource> <Name>`)}\n
|
|
69
69
|
To delete a scoped resource in all scopes with a specific name without confirmation dialog:
|
|
70
|
-
${_chalk.default.cyan(`axway
|
|
70
|
+
${_chalk.default.cyan(`axway engage delete <Resource> <Name> -s/--scope <Scope Name> --yes`)}\n
|
|
71
71
|
To delete a scoped resource in a specific scope:
|
|
72
|
-
${_chalk.default.cyan(`axway
|
|
72
|
+
${_chalk.default.cyan(`axway engage delete <Resource> <Name> -s/--scope <Scope Kind>/<Scope Name>`)}\n
|
|
73
73
|
|
|
74
74
|
The server supports the following resources:
|
|
75
75
|
|
|
@@ -174,7 +174,7 @@ const deleteCmd = exports.deleteCmd = {
|
|
|
174
174
|
desc: 'Delete resources',
|
|
175
175
|
args: [{
|
|
176
176
|
name: 'args',
|
|
177
|
-
desc: 'Command arguments, run "axway
|
|
177
|
+
desc: 'Command arguments, run "axway engage delete" to see the examples',
|
|
178
178
|
multiple: true,
|
|
179
179
|
required: false,
|
|
180
180
|
type: 'string'
|
|
@@ -17,7 +17,7 @@ var _DefinitionsManager = require("../../common/DefinitionsManager");
|
|
|
17
17
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage:edit:environment');
|
|
21
21
|
const action = async ({
|
|
22
22
|
argv,
|
|
23
23
|
console
|
|
@@ -11,7 +11,7 @@ const edit = exports.edit = {
|
|
|
11
11
|
action: ({
|
|
12
12
|
console
|
|
13
13
|
}) => {
|
|
14
|
-
console.log(`${_cliKit.chalk.red('Error: Required resource not specified.')}\n\n` + `You must specify the type of resource to get.\n` + `See 'axway
|
|
14
|
+
console.log(`${_cliKit.chalk.red('Error: Required resource not specified.')}\n\n` + `You must specify the type of resource to get.\n` + `See 'axway engage edit -h' for help and examples`);
|
|
15
15
|
process.exit(1);
|
|
16
16
|
},
|
|
17
17
|
commands: {
|
|
@@ -15,7 +15,7 @@ var _utils = require("../../common/utils");
|
|
|
15
15
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
16
16
|
const {
|
|
17
17
|
log
|
|
18
|
-
} = (0, _snooplogg.default)('
|
|
18
|
+
} = (0, _snooplogg.default)('engage: get');
|
|
19
19
|
const getListOrByName = async (resourceDef, client, scopeName, resourceName, scopeDef, query, progressListener, expand, langDef, fieldSet) => {
|
|
20
20
|
return resourceName ? await client.getResourceByName({
|
|
21
21
|
resourceDef,
|
|
@@ -115,17 +115,17 @@ const get = exports.get = {
|
|
|
115
115
|
console.log(`\nUSAGE:
|
|
116
116
|
|
|
117
117
|
Get a list of the resources:
|
|
118
|
-
${_chalk.default.cyan(`axway
|
|
118
|
+
${_chalk.default.cyan(`axway engage get <Resource>`)}\n
|
|
119
119
|
Get a list of multiple resources:
|
|
120
|
-
${_chalk.default.cyan(`axway
|
|
120
|
+
${_chalk.default.cyan(`axway engage get <Resource1>,<Resource2>,...,<ResourceN>`)}\n
|
|
121
121
|
Get a list of resources in a specific scope:
|
|
122
|
-
${_chalk.default.cyan(`axway
|
|
122
|
+
${_chalk.default.cyan(`axway engage get <Resource> -s/--scope <Scope Kind>/<Scope Name>`)}\n
|
|
123
123
|
Get a list of resources matching a specific RSQL query:
|
|
124
|
-
${_chalk.default.cyan(`axway
|
|
124
|
+
${_chalk.default.cyan(`axway engage get <Resource> -q/--query "<RSQL query>"`)}\n
|
|
125
125
|
Get a specific resource by name in all scopes with a specific name:
|
|
126
|
-
${_chalk.default.cyan(`axway
|
|
126
|
+
${_chalk.default.cyan(`axway engage get <Resource> <Name> -s/--scope <Scope Name>`)}\n
|
|
127
127
|
Get a specific resource by name in a specific scope:
|
|
128
|
-
${_chalk.default.cyan(`axway
|
|
128
|
+
${_chalk.default.cyan(`axway engage get <Resource> <Name> -s/--scope <Scope Kind>/<Scope Name>`)}\n
|
|
129
129
|
|
|
130
130
|
The server supports the following resources:
|
|
131
131
|
|
|
@@ -217,7 +217,7 @@ ${defsManager.getDefsTableForHelpMsg()}`);
|
|
|
217
217
|
desc: 'List one or more resources',
|
|
218
218
|
args: [{
|
|
219
219
|
name: 'args',
|
|
220
|
-
desc: 'Command arguments, run "axway
|
|
220
|
+
desc: 'Command arguments, run "axway engage get" to see the examples',
|
|
221
221
|
multiple: true,
|
|
222
222
|
required: false
|
|
223
223
|
}],
|
|
@@ -41,7 +41,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
|
|
|
41
41
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
42
42
|
const {
|
|
43
43
|
log
|
|
44
|
-
} = (0, _snooplogg.default)('
|
|
44
|
+
} = (0, _snooplogg.default)('engage: install: agents');
|
|
45
45
|
const localhost = exports.localhost = 'localhost';
|
|
46
46
|
const prompts = exports.prompts = {
|
|
47
47
|
hostedAgentOption: 'Will this be an embedded agent',
|
|
@@ -253,9 +253,9 @@ async function finishInstall(agentInstallFlow, installConfig, apiServerClient, p
|
|
|
253
253
|
function checkUserRole(isCentralAdmin, isPlatformAdmin, accountInfo, render) {
|
|
254
254
|
if (!isCentralAdmin || !isPlatformAdmin) {
|
|
255
255
|
if (!accountInfo || accountInfo.isPlatform) {
|
|
256
|
-
render.error('Error: Not authorized. Account must be assigned the roles: Platform Admin,
|
|
256
|
+
render.error('Error: Not authorized. Account must be assigned the roles: Platform Admin, Engage Admin');
|
|
257
257
|
} else {
|
|
258
|
-
render.error('Error: Not authorized. "Service Account" must be authorized with a user account with "Tooling Credentials" assigned the roles: Platform Admin,
|
|
258
|
+
render.error('Error: Not authorized. "Service Account" must be authorized with a user account with "Tooling Credentials" assigned the roles: Platform Admin, Engage Admin');
|
|
259
259
|
render.error('See: https://docs.axway.com/bundle/axwaycli-open-docs/page/docs/authentication/index.html#service-account-with-username-password');
|
|
260
260
|
}
|
|
261
261
|
process.exit(1);
|
|
@@ -17,7 +17,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage: install: agents: apigeeX');
|
|
21
21
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.APIGEEX_DA}`;
|
|
22
22
|
const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.APIGEEX_TA}`;
|
|
23
23
|
const defaultLogFiles = exports.defaultLogFiles = '/group-*_instance-*.log';
|
|
@@ -18,7 +18,7 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
|
|
|
18
18
|
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
|
|
19
19
|
const {
|
|
20
20
|
log
|
|
21
|
-
} = (0, _snooplogg.default)('
|
|
21
|
+
} = (0, _snooplogg.default)('engage: install: agents: saas');
|
|
22
22
|
class DataplaneConfig {
|
|
23
23
|
constructor(type) {
|
|
24
24
|
_defineProperty(this, "type", void 0);
|
|
@@ -186,7 +186,7 @@ const validateFrequency = () => input => {
|
|
|
186
186
|
// @ts-ignore
|
|
187
187
|
const gatewayConnectivity = async installConfig => {
|
|
188
188
|
console.log('\nCONNECTION TO APIGEE X API GATEWAY:');
|
|
189
|
-
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the APIGEE X API Gateway to discover API's for publishing to Amplify
|
|
189
|
+
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the APIGEE X API Gateway to discover API's for publishing to Amplify Engage"));
|
|
190
190
|
|
|
191
191
|
// DeploymentType
|
|
192
192
|
let hostedAgentValues = new SaasAgentValues();
|
|
@@ -17,7 +17,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
|
|
|
17
17
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage: install: agents: aws');
|
|
21
21
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.AWS_DA}`;
|
|
22
22
|
const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.AWS_TA}`;
|
|
23
23
|
const STAGE_TAG_NAME_LENGTH = 127;
|
|
@@ -67,7 +67,7 @@ const AWSPrompts = exports.AWSPrompts = {
|
|
|
67
67
|
CONFIG_BUCKET_EXISTS: 'Does this bucket already exist on AWS, or will you create beforehand?',
|
|
68
68
|
CONFIG_SERVICE: 'Do you want to setup config service?',
|
|
69
69
|
DA_LOG_GROUP: 'Enter the log group name the discovery agent will log to',
|
|
70
|
-
STAGE_TAG_NAME: 'Enter the name of the tag on AWS API Gateway Stage that holds mapped stage on Amplify
|
|
70
|
+
STAGE_TAG_NAME: 'Enter the name of the tag on AWS API Gateway Stage that holds mapped stage on Amplify Engage',
|
|
71
71
|
DA_QUEUE: 'Enter the discovery queue name',
|
|
72
72
|
DEPLOYMENT: 'Select the type of deployment you wish to configure',
|
|
73
73
|
EC2_TYPE: 'Select the EC2 instance type',
|
|
@@ -20,7 +20,7 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
|
|
|
20
20
|
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
|
|
21
21
|
const {
|
|
22
22
|
log
|
|
23
|
-
} = (0, _snooplogg.default)('
|
|
23
|
+
} = (0, _snooplogg.default)('engage: install: agents: saas');
|
|
24
24
|
const STAGE_TAG_NAME_LENGTH = 127;
|
|
25
25
|
class DataplaneConfig {
|
|
26
26
|
constructor(type) {
|
|
@@ -145,7 +145,7 @@ const SaasPrompts = {
|
|
|
145
145
|
ASSUME_ROLE: 'Enter the Role ARN that the agent will Assume',
|
|
146
146
|
EXTERNAL_ID: 'Enter the External ID the Assume Role expects',
|
|
147
147
|
ACCESS_LOG_ARN: 'Enter the ARN for the Access Log that the Discovery will add and the Traceability will use',
|
|
148
|
-
STAGE_TAG_NAME: 'Enter the name of the tag on AWS API Gateway Stage that holds mapped stage on Amplify
|
|
148
|
+
STAGE_TAG_NAME: 'Enter the name of the tag on AWS API Gateway Stage that holds mapped stage on Amplify Engage',
|
|
149
149
|
FULL_TRANSACTION_LOGGING: 'Do you want to enable Full Transaction Logging? Please note that CloudWatch costs would increase when Full Transaction Logging is enabled',
|
|
150
150
|
DA_FREQUENCY: 'How often should the discovery run, leave blank for integrating in CI/CD process',
|
|
151
151
|
DA_FILTER: 'Please enter the filter conditions for discovery of API Services based on tags',
|
|
@@ -302,7 +302,7 @@ const askForAWSCredentials = async hostedAgentValues => {
|
|
|
302
302
|
// @ts-ignore
|
|
303
303
|
const gatewayConnectivity = async installConfig => {
|
|
304
304
|
console.log('\nCONNECTION TO AMAZON API GATEWAY:');
|
|
305
|
-
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the AWS API Gateway to discover API's for publishing to Amplify
|
|
305
|
+
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the AWS API Gateway to discover API's for publishing to Amplify Engage"));
|
|
306
306
|
|
|
307
307
|
// DeploymentType
|
|
308
308
|
let hostedAgentValues = new SaasAgentValues();
|
|
@@ -17,7 +17,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage: install: agents: azure');
|
|
21
21
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.AZURE_DA}`;
|
|
22
22
|
const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.AZURE_TA}`;
|
|
23
23
|
const InvalidMessages = {
|
|
@@ -20,7 +20,7 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
|
|
|
20
20
|
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
|
|
21
21
|
const {
|
|
22
22
|
log
|
|
23
|
-
} = (0, _snooplogg.default)('
|
|
23
|
+
} = (0, _snooplogg.default)('engage: install: agents: saas');
|
|
24
24
|
const InvalidMessages = {
|
|
25
25
|
enterApiManagementServiceName: `The API Management Service Name can contain only letters, numbers and hyphens. The first character must be a letter and last character must be a letter or a number.`
|
|
26
26
|
};
|
|
@@ -310,7 +310,7 @@ const askForAzureCredentials = async (hostedAgentValues, installConfig) => {
|
|
|
310
310
|
// @ts-ignore
|
|
311
311
|
const gatewayConnectivity = async installConfig => {
|
|
312
312
|
console.log('\nCONNECTION TO Azure API GATEWAY:');
|
|
313
|
-
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the Azure API Gateway to discover API's for publishing to Amplify
|
|
313
|
+
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the Azure API Gateway to discover API's for publishing to Amplify Engage"));
|
|
314
314
|
|
|
315
315
|
// DeploymentType
|
|
316
316
|
let hostedAgentValues = new SaasAgentValues();
|
|
@@ -17,7 +17,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage: install: agents: backstage');
|
|
21
21
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.BACKSTAGE_DA}`;
|
|
22
22
|
const defaultLogFiles = exports.defaultLogFiles = '/group-*_instance-*.log';
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ const dockerPublicKey = exports.dockerPublicKey = '/keys/public_key.pem';
|
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
const {
|
|
29
29
|
log
|
|
30
|
-
} = (0, _snooplogg.default)('
|
|
30
|
+
} = (0, _snooplogg.default)('engage: install: agents: edge');
|
|
31
31
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.EDGE_DA}`;
|
|
32
32
|
const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.EDGE_TA}`;
|
|
33
33
|
|
|
@@ -18,7 +18,7 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
|
|
|
18
18
|
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
|
|
19
19
|
const {
|
|
20
20
|
log
|
|
21
|
-
} = (0, _snooplogg.default)('
|
|
21
|
+
} = (0, _snooplogg.default)('engage: install: agents: saas');
|
|
22
22
|
class DataplaneConfig {
|
|
23
23
|
constructor(type) {
|
|
24
24
|
_defineProperty(this, "type", void 0);
|
|
@@ -136,7 +136,7 @@ const validateFrequency = () => input => {
|
|
|
136
136
|
// @ts-ignore
|
|
137
137
|
const gatewayConnectivity = async installConfig => {
|
|
138
138
|
console.log('\nCONNECTION TO GitHub API GATEWAY:');
|
|
139
|
-
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the GitHub API Gateway to discover API's for publishing to Amplify
|
|
139
|
+
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the GitHub API Gateway to discover API's for publishing to Amplify Engage"));
|
|
140
140
|
|
|
141
141
|
// DeploymentType
|
|
142
142
|
let hostedAgentValues = new SaasAgentValues();
|
|
@@ -17,7 +17,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage: install: agents: gitLab:');
|
|
21
21
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.GITLAB_DA}`;
|
|
22
22
|
|
|
23
23
|
// ConfigFiles - all the config file that are used in the setup
|
|
@@ -106,7 +106,7 @@ const gatewayConnectivity = async installConfig => {
|
|
|
106
106
|
let gitLabAgentValues = new _gitLabTemplates.GitLabAgentValues();
|
|
107
107
|
if (installConfig.switches.isDockerInstall) {
|
|
108
108
|
console.log('\nCONNECTION TO GitHub API GATEWAY:');
|
|
109
|
-
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the GitHub API Gateway to discover API's for publishing to Amplify
|
|
109
|
+
console.log(_chalk.default.gray("The Discovery Agent needs to connect to the GitHub API Gateway to discover API's for publishing to Amplify Engage."));
|
|
110
110
|
gitLabAgentValues.token = await askForGitLabToken();
|
|
111
111
|
gitLabAgentValues.baseURL = await askForGitLabBaseURL();
|
|
112
112
|
gitLabAgentValues.repositoryID = await askForGitLabRepositoryID();
|
|
@@ -19,7 +19,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
19
19
|
// @ts-ignore
|
|
20
20
|
const {
|
|
21
21
|
log
|
|
22
|
-
} = (0, _snooplogg.default)('
|
|
22
|
+
} = (0, _snooplogg.default)('engage: install: agents: graylog');
|
|
23
23
|
const amplifyAgentsNs = exports.amplifyAgentsNs = 'amplify-agents';
|
|
24
24
|
|
|
25
25
|
// ConfigFiles - all the config file that are used in the setup
|
|
@@ -65,7 +65,7 @@ const askBasePathSegmentLen = async () => await (0, _basicPrompts.askInput)({
|
|
|
65
65
|
defaultValue: 2
|
|
66
66
|
});
|
|
67
67
|
const gatewayConnectivity = async _installConfig => {
|
|
68
|
-
console.log(_chalk.default.gray(`The Amplify Graylog Agent needs to be deployed to your Kubernetes cluster to discover APIs for publishing to Amplify
|
|
68
|
+
console.log(_chalk.default.gray(`The Amplify Graylog Agent needs to be deployed to your Kubernetes cluster to discover APIs for publishing to Amplify Engage.`));
|
|
69
69
|
const {
|
|
70
70
|
error
|
|
71
71
|
} = await _Kubectl.kubectl.isInstalled();
|
|
@@ -17,7 +17,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
const {
|
|
19
19
|
log
|
|
20
|
-
} = (0, _snooplogg.default)('
|
|
20
|
+
} = (0, _snooplogg.default)('engage: install: agents: ibmAPIConnect');
|
|
21
21
|
const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.IBMAPICONNECT_DA}`;
|
|
22
22
|
const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.IBMAPICONNECT_TA}`;
|
|
23
23
|
const defaultLogFiles = exports.defaultLogFiles = '/group-*_instance-*.log';
|
|
@@ -15,7 +15,7 @@ const install = exports.install = {
|
|
|
15
15
|
const renderer = new _Renderer.default(console);
|
|
16
16
|
renderer.error('Error: You must specify the type of the resource to install.');
|
|
17
17
|
console.log(`\nUSAGE:
|
|
18
|
-
To install agents in interactive mode:\t"axway
|
|
18
|
+
To install agents in interactive mode:\t"axway engage install agents"
|
|
19
19
|
`);
|
|
20
20
|
process.exit(1);
|
|
21
21
|
},
|
|
@@ -25,7 +25,7 @@ To install agents in interactive mode:\t"axway central install agents"
|
|
|
25
25
|
desc: 'Install additional platform resources',
|
|
26
26
|
args: [{
|
|
27
27
|
name: 'args',
|
|
28
|
-
desc: 'Command arguments, run "axway
|
|
28
|
+
desc: 'Command arguments, run "axway engage install" to see the examples',
|
|
29
29
|
multiple: true,
|
|
30
30
|
required: false,
|
|
31
31
|
type: 'string'
|
|
@@ -21,7 +21,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
const {
|
|
23
23
|
log
|
|
24
|
-
} = (0, _snooplogg.default)('
|
|
24
|
+
} = (0, _snooplogg.default)('engage: install: agents: istio:');
|
|
25
25
|
const amplifyAgentsNs = exports.amplifyAgentsNs = 'amplify-agents';
|
|
26
26
|
const gatewayCertSecret = exports.gatewayCertSecret = 'gateway-cert';
|
|
27
27
|
const istioSystemNs = exports.istioSystemNs = 'istio-system';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@axway/axway-central-cli",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.14.0-rc.0",
|
|
4
4
|
"description": "Manage APIs, services and publish to the Amplify Marketplace",
|
|
5
5
|
"homepage": "https://platform.axway.com",
|
|
6
6
|
"author": {
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
"amplify",
|
|
18
18
|
"apicentral",
|
|
19
19
|
"central",
|
|
20
|
+
"engage",
|
|
20
21
|
"amplify-package"
|
|
21
22
|
],
|
|
22
23
|
"repository": {
|
|
@@ -39,7 +40,7 @@
|
|
|
39
40
|
},
|
|
40
41
|
"cli-kit": {
|
|
41
42
|
"main": "./dist/cli.js",
|
|
42
|
-
"name": "central"
|
|
43
|
+
"name": "engage,central"
|
|
43
44
|
},
|
|
44
45
|
"dependencies": {
|
|
45
46
|
"@axway/amplify-cli-utils": "^5.0.11",
|