@axway/amplify-central-mulesoft-extension

@axway/mulesoft-extension

Amplify Central CLI extension for downloading and creating Amplify Central resources for Mulesoft.

For more documentation and examples please visit Unified Catalog integrations.

Disclaimer

This extension is example code and comes with no guarantee of support or maintenance.

PreReqs

This assumes you already have npm installed and have an mulesoft account setup. Visit NodeJS to learn how to install NodeJS. If you need help with setting up your mulesoft account, you can view the Setup section of the local DEVREADME.MD

Installation

Assuming you are familiar with Node.js and npm, you should first install the Axway Amplify CLI, which will give you connectivity to the Axway Amplify Platform. Note that you must first have an account on https://platform.axway.com, and be provisioned in Amplify Central:

$ [sudo] npm install -g axway

Use the Amplify package manager command to install the Amplify Central CLI:

$ axway pm install @axway/axway-central-cli

You can then install the @axway/amplify-central-mulesoft-extension:

$ npm install @axway/amplify-central-mulesoft-extension
$ axway central config set extensions.mulesoft <path to where you installed module>

Getting started

You must be logged into the Axway Amplify Platform before uploading any generated resource files. Refer to the Axway Central CLI documentation for more information.

General usage

There are two main extension commands; config and resources. You can run each command with a -h to get help on that specific command.

$ axway central mulesoft-extension -h
USAGE: axway central mulesoft-extension <command> [options]

Create Amplify Central resources from Mulesoft API Management APIs

AMPLIFY CENTRAL EXTENSION FOR MULESOFT API MANAGEMENT COMMANDS:
  config  Manage Mulesoft Extension Configuration
  resources  Generate resources from Mulesoft API Management APIs

Commands reference:

CONFIG

The config command is utilized to configure the extension prior to generating resources. There are two config sub-commands; list and set.

$ axway central mulesoft-extension config -h
USAGE: axway central mulesoft-extension config <command> [options]

Manage Mulesoft Extension Configuration

CONFIG COMMANDS:
  list  View Amplify Central mulesoft-extension configuration
  set  Set Amplify Central mulesoft-extension configuration

config examples:

# set output dir for the generated resources:
$ axway central mulesoft-extension config set --output-dir=<directory>
# view config:
$ axway central mulesoft-extension config list
# view list of available options
$ axway central mulesoft-extension config set -h

SET OPTIONS:
  --environment-name=<value>  Required: Set environment name to create
  --generate-consumer-instances=<value>  Bool to generate consumer instances
  --icon=<value>  Set absolute path for custom icon
  --include-mock-endpoints=<value>  Bool to include mock endpoints
  --master-organization-id=<value>  Required: Set your Mulesoft Master Organizatoin Id
  --output-dir=<value>  Set absolute path for output directory
  --password=<value>  Required: Set your Mulesoft password
  --username=<value>  Required: Set your Mulesoft username
  --webhook-secret=<value>  Set secret to invoke webhook
  --webhook-url=<value>  Set webhook url to use
  --anypoint-exchange-url=<value> Set to change the Mulesoft AnyPoint Exchange URL. Default value is https://anypoint.mulesoft.com

RESOURCES

The resources command is utilized to generate mulesoft resources for Central. There is one resources sub-command: generate

$ axway central mulesoft-extension resources -h

USAGE: axway central mulesoft-extension resources <command> [options]

Generate resources from Mulesoft API Management APIs

RESOURCES COMMANDS:
  generate

resources examples:

$ axway central mulesoft-extension resources generate

Generated Files

The generate command will create Amplify Central resource files for your configured Mulesoft instance. These files will generated into either ./resources or the directory you configured with the --output-dir configuration setting.

After generating these files you can modify and upload them to Amplify Central with the axway central create -f=<file> command. You'll want be sure to upload any Environment files before other generate resources.

$ axway central create -h
USAGE: axway central create <command> [options]

Create a resource from a file. JSON and YAML formats are accepted.

CREATE COMMANDS:
  environment   Create an environment with the specified name.

CREATE OPTIONS:
  --client-id=<value>   Override your DevOps account's client ID
  -f,--file=<path>      Filename to use to create the resource
  -o,--output=<value>   Additional output formats. One of: yaml | json

create example:

# Upload the Environment, Webhook, and ConsumerSubscriptionDefinition
axway central create -f=~/Desktop/Environment.yaml
# Upload the APIService, APIServiceRevision, APIServiceInstance, and ConsumerInstance
axway central create -f=~/Desktop/APIService-swagger-petstore.yaml

Author

Axway [e-mail] https://axway.com

License

Copyright 2021 Axway

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.