@axway/axway-central-cli 3.6.0-rc.1 → 3.6.0

package/README.md

@@ -308,7 +308,8 @@ GET OPTIONS:
   --attribute [key=value]          Attribute in key=value pair format to filter by
   --no-cache                       Do not use cache when communicating with the server
   --account [value]                Override your default account config
-  --language [langCode]            Show the language detail of the retruned object. One of: * | fr-fr | en-us | de-de | pt-br
+  --language=[langCode]            Show the language detail of the retruned object. One of: * | fr-fr | en-us | de-de | pt-br
+  --languageDefinition=[langCode]  Show the language definition constraint of the returned object. One of: fr-fr | en-us | de-de | pt-br
   -o, --output [value]             Additional output formats. One of: yaml | json
   -q, --query [RSQL query]         RSQL-formatted query to search for filters that match specific parameters
   --region [value]                 Override your region config
@@ -354,6 +355,22 @@ axway central get assets --tag tag1
 axway central get assets --attribute location=arizona
 # get assets and filter the list with a combination of title, tag and attribute filters
 axway central get assets --title test --tag tag1 --attribute location=arizona
+# To get a product with name "test-product" with French language translation if available in YAML format
+axway central get products test-product --language="fr-fr" -o yaml
+# To get a product with name "test-product" with German language translation if available in YAML format
+axway central get products test-product --language="de-de" -o yaml
+# To get a product with name "test-product" with US English language translation if available in YAML format
+axway central get products test-product --language="en-us" -o yaml
+# To get a product with name "test-product" with Portugal language translation if available in YAML format
+axway central get products test-product --language="pt-br" -o yaml
+# To get a stage with name "demo-stage" with the French language translation in JSON format
+axway central get stages demo-stage --languageDefinition="fr-fr" -o json
+# To get a stage with name "demo-stage" with the US English language translation in JSON format
+axway central get stages demo-stage --languageDefinition="en-us" -o json
+# To get a stage with name "demo-stage" with the German language translation in JSON format
+axway central get stages demo-stage --languageDefinition="de-de" -o json
+# To get a stage with name "demo-stage" with the Portugese language translation in JSON format
+axway central get stages demo-stage --languageDefinition="pt-br" -o json
 ```
 
 ---
@@ -491,6 +508,7 @@ DELETE OPTIONS:
   -s, --scope [name] or [kind/name]  Scope name or kind/name for scoped resources.
   --wait                             Wait for the resources to be completely deleted.
   -y, --yes                          Automatically reply "yes" to any command prompts.
+  --forceDelete                      Force delete a resource (Warning: Ignores finalizers on the resource and the resources scoped under it)
 ```
 
 ### delete examples
@@ -506,6 +524,12 @@ axway central delete docs somedoc -s somescope -y
 axway central delete docs somedoc -s AssetRelease/somescope -y
 # delete all resources specified in the file
 axway central delete -f ./some/folder/resources.yaml
+# force delete environment by name with a prompt
+axway central delete environment newenv --forceDelete
+# force delete API service by name (a scoped resource) with a prompt
+axway central delete apisvc someapisvc -s newenv --forceDelete
+# force delete all resources specified in the file without a prompt
+axway central delete -f ./some/folder/resources.yaml --forceDelete --yes
 ```
 
 ---

package/dist/commands/delete/index.js

@@ -191,6 +191,6 @@ const deleteCmd = exports.deleteCmd = {
     },
     '-y, --yes': 'Automatically reply "yes" to any command prompts.',
     '--wait': 'Wait for the resources to be completely deleted.',
-    '--forceDelete': 'Force delete a resource (Warning: Ignores finalizers)'
+    '--forceDelete': 'Force delete a resource (Warning: Ignores finalizers on the resource and the resources scoped under it)'
   }
 };

package/dist/commands/install/agents.js

@@ -32,6 +32,7 @@ var ibmAPIConnectAgent = _interopRequireWildcard(require("./ibmAPIConnectAgents"
 var softwareAGWebMethodsAgent = _interopRequireWildcard(require("./softwareAGWebMethodsAgents"));
 var traceableAgent = _interopRequireWildcard(require("./traceableAgents"));
 var platform = _interopRequireWildcard(require("./platform"));
+var backstageAgent = _interopRequireWildcard(require("./backstageAgents"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -55,7 +56,8 @@ const agentInstallFlows = {
   [_types.GatewayTypes.GRAYLOG]: graylogAgent.GraylogInstallMethods,
   [_types.GatewayTypes.IBMAPICONNECT]: ibmAPIConnectAgent.IBMAPIConnectInstallMethods,
   [_types.GatewayTypes.SOFTWAREAGWEBMETHODS]: softwareAGWebMethodsAgent.SoftwareAGWebMethodsInstallMethods,
-  [_types.GatewayTypes.TRACEABLE]: traceableAgent.TraceableInstallMethods
+  [_types.GatewayTypes.TRACEABLE]: traceableAgent.TraceableInstallMethods,
+  [_types.GatewayTypes.BACKSTAGE]: backstageAgent.BackstageInstallMethods
 };
 const saasAgentInstallFlows = {
   [_types.SaaSGatewayTypes.AWS_GATEWAY]: awsSaaSAgents.AWSSaaSInstallMethods,

package/dist/commands/install/backstageAgents.js

@@ -0,0 +1,168 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.testables = exports.gatewayConnectivity = exports.defaultLogFiles = exports.completeInstall = exports.askConfigType = exports.askBundleType = exports.ConfigFiles = exports.BackstageInstallMethods = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _snooplogg = _interopRequireDefault(require("snooplogg"));
+var _basicPrompts = require("../../common/basicPrompts");
+var _types = require("../../common/types");
+var _utils = require("../../common/utils");
+var helpers = _interopRequireWildcard(require("./helpers"));
+var _backstageTemplates = require("./helpers/templates/backstageTemplates");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// @ts-ignore
+const {
+  log
+} = (0, _snooplogg.default)('central: install: agents: backstage');
+const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.BACKSTAGE_DA}`;
+const defaultLogFiles = exports.defaultLogFiles = '/group-*_instance-*.log';
+
+// ConfigFiles - all the config file that are used in the setup
+const ConfigFiles = exports.ConfigFiles = {
+  DAEnvVars: `${helpers.configFiles.DA_ENV_VARS}`,
+  BackstageDABinaryFile: 'discovery_agent',
+  BackstageDAYaml: 'discovery_agent.yml'
+};
+const BackstagePrompts = {
+  enterUrlHost: 'Enter the host of the URL for connecting to Backstage',
+  selectUrlScheme: 'Select the scheme of the URL for connecting to Backstage',
+  enterBackendPort: '(Optional) Enter the backend port of the URL for connecting to Backstage',
+  enterUrlPath: '(Optional) Enter the path of the URL for connecting to Backstage',
+  selectAuthMode: 'Select the authentication type for connecting to Backstage',
+  enterStaticTokenValue: 'Enter the static token value',
+  enterJwksClientID: 'Enter the ClientID for the JWKS Auth Flow',
+  enterJwksClientSecret: 'Enter the ClientSecret for the JWKS Auth Flow',
+  enterJwksTokenURL: 'Enter TokenURL for the JWKS Auth Flow'
+};
+const askBundleType = async () => {
+  // Backstage agent has only DA
+  return _types.BundleType.DISCOVERY;
+};
+exports.askBundleType = askBundleType;
+const askConfigType = async () => {
+  return _types.AgentConfigTypes.DOCKERIZED;
+};
+
+//
+// Questions for the configuration of Backstage agent
+//
+exports.askConfigType = askConfigType;
+const askBackstageUrlHost = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterUrlHost
+});
+const askBackstageUrlScheme = async () => await (0, _basicPrompts.askList)({
+  msg: BackstagePrompts.selectUrlScheme,
+  choices: [_backstageTemplates.UrlScheme.HTTP, _backstageTemplates.UrlScheme.HTTPS]
+});
+const askBackstageUrlBackendPort = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterBackendPort,
+  allowEmptyInput: true
+});
+const askBackstageUrlPath = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterUrlPath,
+  allowEmptyInput: true
+});
+const askBackstageAuthMode = async () => await (0, _basicPrompts.askList)({
+  msg: BackstagePrompts.selectAuthMode,
+  choices: [{
+    name: "No auth",
+    value: _backstageTemplates.AuthMode.NoAuth
+  }, _backstageTemplates.AuthMode.Guest, _backstageTemplates.AuthMode.StaticToken, _backstageTemplates.AuthMode.Jwks]
+});
+const askBackstageAuthStaticToken = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterStaticTokenValue
+});
+const askBaskstageAuthJwksClientID = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterJwksClientID
+});
+const askBaskstageAuthJwksClientSecret = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterJwksClientSecret
+});
+const askBaskstageAuthJwksTokenUrl = async () => await (0, _basicPrompts.askInput)({
+  msg: BackstagePrompts.enterJwksTokenURL
+});
+const gatewayConnectivity = async () => {
+  const backstageAgentValues = new _backstageTemplates.BackstageAgentValues();
+  console.log('\nCONNECTION TO Backstage:');
+  console.log(_chalk.default.gray(`The discovery agent needs to connect to Backstage to discover API's for publishing to Amplify.`));
+  await askPrompts(backstageAgentValues);
+  return backstageAgentValues;
+};
+exports.gatewayConnectivity = gatewayConnectivity;
+const generateSuccessHelpMsg = installConfig => {
+  console.log(_chalk.default.yellow('\nPlease make sure to copy the "private_key.pem" and "public_key.pem" files for the existing service account you selected.'));
+  dockerSuccessMsg(installConfig);
+  console.log(_chalk.default.gray(`\nAdditional information about agent features can be found here:\n${helpers.agentsDocsUrl.BACKSTAGE}`));
+};
+const dockerSuccessMsg = installConfig => {
+  let dockerInfo;
+  const runDaLinuxMsg = `docker run -it --env-file ${helpers.pwd}/${helpers.configFiles.DA_ENV_VARS} -v ${helpers.pwd}:/keys ${helpers.eolChar}`;
+  const runDaWinMsg = `docker run -it --env-file ${helpers.pwdWin}/${helpers.configFiles.DA_ENV_VARS} -v ${helpers.pwdWin}:/keys ${helpers.eolCharWin}`;
+  const startDaLinuxMsg = `\nStart the Discovery Agent on a Linux based machine`;
+  const startDaWinMsg = `\nStart the Discovery Agent on a Windows machine`;
+  dockerInfo = `To utilize the agents, pull the latest Docker images and run them using the appropriate supplied environment files, (${helpers.configFiles.DA_ENV_VARS}:`;
+  console.log(_chalk.default.whiteBright(dockerInfo), '\n');
+  const daImageVersion = `${daImage}:${installConfig.daVersion}`;
+  console.log(_chalk.default.white('Pull the latest image of the Discovery Agent:'));
+  console.log(_chalk.default.cyan(`docker pull ${daImageVersion}`));
+  console.log(_chalk.default.white(_utils.isWindows ? startDaWinMsg : startDaLinuxMsg));
+  console.log(_chalk.default.cyan(_utils.isWindows ? runDaWinMsg : runDaLinuxMsg));
+  console.log('\t', _chalk.default.cyan(`-v /data ${daImageVersion}`), '\n');
+};
+async function askPrompts(values) {
+  values.host = await askBackstageUrlHost();
+  values.scheme = await askBackstageUrlScheme();
+  values.backendPort = await askBackstageUrlBackendPort();
+  values.urlPath = await askBackstageUrlPath();
+  values.authMode = await askBackstageAuthMode();
+  switch (values.authMode) {
+    case _backstageTemplates.AuthMode.StaticToken:
+      {
+        values.staticTokenValue = await askBackstageAuthStaticToken();
+        break;
+      }
+    case _backstageTemplates.AuthMode.Jwks:
+      {
+        values.jwksClientID = await askBaskstageAuthJwksClientID();
+        values.jwksClientSecret = await askBaskstageAuthJwksClientSecret();
+        values.jwksTokenURL = await askBaskstageAuthJwksTokenUrl();
+        break;
+      }
+  }
+  return values;
+}
+const completeInstall = async installConfig => {
+  /**
+   * Create agent resources
+   */
+  const backstageAgentValues = installConfig.gatewayConfig;
+
+  // Add final settings
+  backstageAgentValues.centralConfig = installConfig.centralConfig;
+  console.log('Generating the configuration file(s)...');
+  (0, _utils.writeTemplates)(ConfigFiles.DAEnvVars, backstageAgentValues, _backstageTemplates.backstageDAEnvVarTemplate);
+  console.log('Configuration file(s) have been successfully created.\n');
+  generateSuccessHelpMsg(installConfig);
+};
+exports.completeInstall = completeInstall;
+const BackstageInstallMethods = exports.BackstageInstallMethods = {
+  GetBundleType: askBundleType,
+  GetDeploymentType: askConfigType,
+  AskGatewayQuestions: gatewayConnectivity,
+  FinalizeGatewayInstall: completeInstall,
+  ConfigFiles: Object.values(ConfigFiles),
+  AgentNameMap: {
+    [_types.AgentTypes.da]: _types.AgentNames.BACKSTAGE_DA,
+    [_types.AgentTypes.ta]: _types.AgentNames.BACKSTAGE_DA
+  },
+  GatewayDisplay: _types.GatewayTypes.BACKSTAGE
+};
+const testables = exports.testables = {
+  BackstagePrompts,
+  ConfigFiles,
+  defaultLogFiles
+};

package/dist/commands/install/helpers/index.js

@@ -233,7 +233,8 @@ const agentsDocsUrl = exports.agentsDocsUrl = {
   GRAYLOG: 'https://docs.axway.com/bundle/amplify-central/page/docs/connect_manage_environ/mesh_management/index.html',
   IBMAPICONNECT: '',
   SOFTWAREAGWEBMETHODS: '',
-  TRACEABLE: ''
+  TRACEABLE: '',
+  BACKSTAGE: ''
 };
 
 // export * from './updaters';

package/dist/commands/install/helpers/templates/backstageTemplates.js

@@ -0,0 +1,95 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.backstageDAEnvVarTemplate = exports.UrlScheme = exports.BackstageAgentValues = exports.AuthMode = void 0;
+var _types = require("../../../../common/types");
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+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); }
+/**
+ * @description Parameters to provide to the Backstage handlebars templates.
+ */
+class BackstageAgentValues {
+  constructor() {
+    _defineProperty(this, "host", void 0);
+    _defineProperty(this, "scheme", void 0);
+    _defineProperty(this, "backendPort", void 0);
+    _defineProperty(this, "urlPath", void 0);
+    _defineProperty(this, "authMode", void 0);
+    _defineProperty(this, "staticTokenValue", void 0);
+    _defineProperty(this, "jwksClientID", void 0);
+    _defineProperty(this, "jwksClientSecret", void 0);
+    _defineProperty(this, "jwksTokenURL", void 0);
+    _defineProperty(this, "centralConfig", void 0);
+    this.host = '';
+    this.scheme = UrlScheme.HTTP;
+    this.backendPort = 0;
+    this.urlPath = '';
+    this.authMode = AuthMode.NoAuth;
+    this.staticTokenValue = '';
+    this.jwksClientID = '';
+    this.jwksClientSecret = '';
+    this.jwksTokenURL = '';
+    this.centralConfig = new _types.CentralAgentConfig();
+  }
+}
+exports.BackstageAgentValues = BackstageAgentValues;
+let UrlScheme = exports.UrlScheme = /*#__PURE__*/function (UrlScheme) {
+  UrlScheme["HTTP"] = "http";
+  UrlScheme["HTTPS"] = "https";
+  return UrlScheme;
+}({});
+let AuthMode = exports.AuthMode = /*#__PURE__*/function (AuthMode) {
+  AuthMode["NoAuth"] = "";
+  AuthMode["Guest"] = "guest";
+  AuthMode["StaticToken"] = "token";
+  AuthMode["Jwks"] = "jwks";
+  return AuthMode;
+}({});
+/**
+ * @description Generates the Backstage DA env vars file.
+ */
+const backstageDAEnvVarTemplate = () => {
+  return `# Backstage configs
+BACKSTAGE_URL_SCHEME={{scheme}}
+BACKSTAGE_URL_HOST={{host}}
+{{#compare . backendPort 0 operator=">="}}
+BACKSTAGE_URL_BACKENDPORT={{backendPort}}
+{{/compare}}
+{{#compare . urlPart ""}}
+BACKSTAGE_URL_PATH={{urlPath}}
+{{/compare}}
+{{#compare . authMode "" operator="!="}}
+BACKSTAGE_AUTH_MODE={{authMode}}
+{{/compare}}
+{{#compare . authMode "token"}}
+BACKSTAGE_AUTH_STATICTOKEN={{staticTokenValue}}
+{{/compare}}
+{{#compare . authMode "jwks"}}
+BACKSTAGE_AUTH_CLIENTID={{jwksClientID}}
+BACKSTAGE_AUTH_CLIENTSECRET={{jwksClientSecret}}
+BACKSTAGE_AUTH_TOKENURL={{jwksTokenURL}}
+{{/compare}}
+
+# Amplify Central configs
+CENTRAL_AGENTNAME={{centralConfig.daAgentName}}
+CENTRAL_AUTH_CLIENTID={{centralConfig.dosaAccount.clientId}}
+CENTRAL_AUTH_PRIVATEKEY={{centralConfig.dosaAccount.templatePrivateKey}}
+CENTRAL_AUTH_PUBLICKEY={{centralConfig.dosaAccount.templatePublicKey}}
+CENTRAL_ENVIRONMENT={{centralConfig.environment}}
+CENTRAL_ORGANIZATIONID={{centralConfig.orgId}}
+CENTRAL_TEAM={{centralConfig.ampcTeamName}}
+CENTRAL_REGION={{centralConfig.region}}
+
+# Logging configs
+# Define the logging level: info, debug, error
+LOG_LEVEL=info
+# Specify where to send the log: stdout, file, both
+LOG_OUTPUT=stdout
+# Define where the log files are written
+LOG_FILE_PATH=logs
+`;
+};
+exports.backstageDAEnvVarTemplate = backstageDAEnvVarTemplate;

package/dist/common/types.js

@@ -239,6 +239,7 @@ let AgentNames = exports.AgentNames = /*#__PURE__*/function (AgentNames) {
   AgentNames["TRACEABLE_TA"] = "traceable-agent";
   AgentNames["SOFTWAREAGWEBMETHODS_DA"] = "software-ag-web-methods-discovery-agent";
   AgentNames["SOFTWAREAGWEBMETHODS_TA"] = "software-ag-web-methods-traceability-agent";
+  AgentNames["BACKSTAGE_DA"] = "backstage-discovery-agent";
   return AgentNames;
 }({});
 let GatewayTypes = exports.GatewayTypes = /*#__PURE__*/function (GatewayTypes) {
@@ -254,6 +255,7 @@ let GatewayTypes = exports.GatewayTypes = /*#__PURE__*/function (GatewayTypes) {
   GatewayTypes["IBMAPICONNECT"] = "IBM API Connect";
   GatewayTypes["SOFTWAREAGWEBMETHODS"] = "Software AG WebMethods";
   GatewayTypes["TRACEABLE"] = "Traceable";
+  GatewayTypes["BACKSTAGE"] = "Backstage";
   return GatewayTypes;
 }({});
 let SaaSGatewayTypes = exports.SaaSGatewayTypes = /*#__PURE__*/function (SaaSGatewayTypes) {
@@ -278,6 +280,7 @@ let DataPlaneNames = exports.DataPlaneNames = /*#__PURE__*/function (DataPlaneNa
   DataPlaneNames["SWAGGERHUB"] = "SwaggerHub";
   DataPlaneNames["TRACEABLE"] = "Traceable";
   DataPlaneNames["MULESOFT"] = "Mulesoft";
+  DataPlaneNames["BACKSTAGE"] = "Backstage";
   DataPlaneNames["OTHER"] = "Unidentified";
   return DataPlaneNames;
 }({});
@@ -296,7 +299,8 @@ const GatewayTypeToDataPlane = exports.GatewayTypeToDataPlane = {
   [SaaSGatewayTypes.SWAGGERHUB]: DataPlaneNames.SWAGGERHUB,
   [GatewayTypes.GRAYLOG]: DataPlaneNames.GRAYLOG,
   [GatewayTypes.IBMAPICONNECT]: DataPlaneNames.IBMAPICONNECT,
-  [GatewayTypes.TRACEABLE]: DataPlaneNames.TRACEABLE
+  [GatewayTypes.TRACEABLE]: DataPlaneNames.TRACEABLE,
+  [GatewayTypes.BACKSTAGE]: DataPlaneNames.BACKSTAGE
 };
 let AgentResourceKind = exports.AgentResourceKind = /*#__PURE__*/function (AgentResourceKind) {
   AgentResourceKind["da"] = "DiscoveryAgent";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axway/axway-central-cli",
-	"version": "3.6.0-rc.1",
+	"version": "3.6.0",
 	"description": "Manage APIs, services and publish to the Amplify Marketplace",
 	"homepage": "https://platform.axway.com",
 	"author": {