clever-tools 3.5.2 → 3.6.0

package/README.md

@@ -2,9 +2,11 @@
 
 Deploy on Clever Cloud and control you applications, add-ons, services from command line.
 
+- [Create a Clever Cloud account](https://console.clever-cloud.com)
+
 ## Installation
 
-Clever Tools are availables from many channels. The simpler way to install them, if you already have Node.js on your system, is through `npm` package manager:
+Clever Tools are available from many channels. The simpler way to install them, if you already have Node.js on your system, is through `npm` package manager:
 
 ```sh
 npm install -g clever-tools
@@ -43,112 +45,18 @@ clever --zsh-autocomplete-script $(which clever) | sudo tee /usr/share/zsh/site-
 
 ## How to use
 
-### Login
-
-To use `clever-tools`, you have to login.
+You can then login and check everything is working:
 
-```sh
+```bash
 clever login
+clever profile
 ```
 
-It will open the Web console in your browser and reuse your existing session if you're already logged in.
-
-`clever login` tries to open a browser through `xdg-open` on GNU/Linux systems (and in bash for windows).
-Make sure you have `xdg-utils` available as well as a default browser set, or you can copy and paste the URL displayed in the console.
-
-### Create an application
-
-```sh
-clever create <name> --type <type> \
-  [--region <region>] \
-  [--org <organisation>] \
-  [--alias <alias>]
-```
-
-Where `type` is one of:
-
-- `docker`: for Docker-based applications
-- `go`: for Go applications
-- `gradle`: for applications launched with gradle
-- `haskell`: for haskell applications
-- `jar`: for applications deployed as standalone jar files
-- `maven`: for applications launched with maven
-- `meteor`: for Meteor applications launched with Node.js
-- `node`: for Node.js applications
-- `php`: for PHP applications
-- `play1`: for Play1 applications
-- `play2`: for Play2 applications
-- `python`: for python27 and python3 applications
-- `ruby`: for ruby applications
-- `rust`: for rust applications
-- `sbt`: for applications launched with SBT
-- `static-apache`: for static (HTML only) websites
-- `war`: for applications deployed as war files
-
-Where region is one of:
-
-- `par` (Paris, [Clever Cloud](https://www.clever-cloud.com/infrastructure/))
-- `grahds` (Gravelines, HDS servers, OVHcloud)
-- `rbx` (Roubaix, OVHcloud)
-- `rbxhds` (Roubaix, HDS servers, OVHcloud)
-- `scw` (Paris, [Scaleway DC5](https://www.clever-cloud.com/blog/press/2023/01/17/clever-cloud-and-scaleway-join-forces-to-unveil-a-sovereign-european-paas-offering/))
-- `mtl` (Montreal, OVHcloud)
-- `sgp` (Singapore, OVHcloud)
-- `syd` (Sydney, OVHcloud)
-- `wsw` (Warsaw, OVHcloud)
-
-`--org` allows you to chose the organisation in which your app is created.
-
-`--alias` allows you to deploy the same application in multiple environments on Clever Cloud (eg: production, testing, …)
-
-### Link an existing application
-
-```sh
-clever link [--org <ORG-NAME>] <APP-NAME> [--alias <alias>]
-```
-
-Where `APP-NAME` is the name of your application, and `ORG-NAME` is the name
-of the organisation it's in. You can specify a complete application id instead
-of its name (in that case, `--org` can be omitted).
-
-### Deploy an application
-
-```sh
-clever deploy [--alias <alias>]
-```
-
-`--alias` allows you to deploy your application several times on Clever Cloud
-(eg: production, testing, …)
-
-### Application status
-
-```sh
-clever status [--alias <alias>]
-```
-
-### Change application scalability
-
-```sh
-clever scale [--alias <alias>] [--min-flavor <minflavor>] [--max-flavor <maxflavor>] [--min-instances <mininstances>] [--max-instances <maxinstances>]
-```
-
-### Display help
-
-You can display help about each command with `clever help`.
-
-```sh
-clever help
-clever help deploy
-```
+Discover how to use Clever Tools through [our documentation](docs/).
 
 ## Examples
 
-```sh
-cd node_project
-clever login
-clever create "Node.js application" -t node -r mtl
-clever deploy
-```
+Discover how to deploy many applications on Clever Cloud within [our guides](https://developers.clever-cloud.com/guides/).
 
 ## How to send feedback?
 
@@ -159,7 +67,6 @@ clever deploy
 This project uses GitHub Actions to build binaries, package them and release them automatically on the various repositories.
 If you want to know more or if you need to release a new version, please read [RELEASE.md](./RELEASE.md) carefully.
 
-
 ## License
 
 This project is licensed under the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html).

package/bin/clever.js

@@ -80,11 +80,11 @@ function run () {
   // ARGUMENTS
   const args = {
     addonIdOrName: cliparse.argument('addon-id', {
-      description: 'Addon ID (or name, if unambiguous)',
+      description: 'Add-on ID (or name, if unambiguous)',
       parser: Parsers.addonIdOrName,
     }),
-    addonName: cliparse.argument('addon-name', { description: 'Addon name' }),
-    addonProvider: cliparse.argument('addon-provider', { description: 'Addon provider' }),
+    addonName: cliparse.argument('addon-name', { description: 'Add-on name' }),
+    addonProvider: cliparse.argument('addon-provider', { description: 'Add-on provider' }),
     alias: cliparse.argument('app-alias', { description: 'Application alias' }),
     appIdOrName: cliparse.argument('app-id', {
       description: 'Application ID (or name, if unambiguous)',
@@ -143,7 +143,7 @@ function run () {
     importAsJson: cliparse.flag('json', {
       description: 'Import variables as JSON (an array of { "name": "THE_NAME", "value": "THE_VALUE" } objects)',
     }),
-    addonId: cliparse.option('addon', { metavar: 'addon_id', description: 'Addon ID' }),
+    addonId: cliparse.option('addon', { metavar: 'addon_id', description: 'Add-on ID' }),
     after: cliparse.option('after', {
       metavar: 'after',
       aliases: ['since'],
@@ -249,7 +249,7 @@ function run () {
     linkAddon: cliparse.option('link', {
       aliases: ['l'],
       metavar: 'alias',
-      description: 'Link the created addon to the app with the specified alias',
+      description: 'Link the created add-on to the app with the specified alias',
       complete: Application('listAvailableAliases'),
     }),
     listAllNotifications: cliparse.flag('list-all', { description: 'List all notifications for your user or for an organisation with the \'--org\' option' }),
@@ -291,7 +291,7 @@ function run () {
       required: true,
       parser: Parsers.commaSeparated,
     }),
-    onlyAddons: cliparse.flag('only-addons', { description: 'Only show addon dependencies' }),
+    onlyAddons: cliparse.flag('only-addons', { description: 'Only show add-on dependencies' }),
     onlyAliases: cliparse.flag('only-aliases', { description: 'List only application aliases' }),
     onlyApps: cliparse.flag('only-apps', { description: 'Only show app dependencies' }),
     orgaIdOrName: cliparse.option('org', {
@@ -306,13 +306,13 @@ function run () {
     drainPassword: cliparse.option('password', {
       aliases: ['p'],
       metavar: 'password',
-      description: 'HTTP basic auth password',
+      description: '(HTTP drains) basic auth password',
     }),
     addonPlan: cliparse.option('plan', {
       aliases: ['p'],
       default: '',
       metavar: 'plan',
-      description: 'Addon plan, depends on the provider',
+      description: 'Add-on plan, depends on the provider',
       complete: Addon('completePlan'),
     }),
     quiet: cliparse.flag('quiet', { aliases: ['q'], description: 'Don\'t show logs during deployment' }),
@@ -323,16 +323,16 @@ function run () {
       aliases: ['r'],
       default: 'par',
       metavar: 'region',
-      description: 'Region to provision the addon in, depends on the provider',
+      description: 'Region to provision the add-on in, depends on the provider',
       complete: Addon('completeRegion'),
     }),
     addonVersion: cliparse.option('addon-version', {
       metavar: 'addon-version',
-      description: 'The version to use for the addon',
+      description: 'The version to use for the add-on',
     }),
     addonOptions: cliparse.option('option', {
       metavar: 'option',
-      description: 'Option to enable for the addon. Multiple --option argument can be passed to enable multiple options',
+      description: 'Option to enable for the add-on. Multiple --option argument can be passed to enable multiple options',
     }),
     region: cliparse.option('region', {
       aliases: ['r'],
@@ -351,7 +351,7 @@ function run () {
     }),
     notificationScope: cliparse.option('service', {
       metavar: 'service_id',
-      description: 'Restrict notifications to specific applications and addons',
+      description: 'Restrict notifications to specific applications and add-ons',
       parser: Parsers.commaSeparated,
     }),
     showAllActivity: cliparse.flag('show-all', { description: 'Show all activity' }),
@@ -376,28 +376,33 @@ function run () {
     drainUsername: cliparse.option('username', {
       aliases: ['u'],
       metavar: 'username',
-      description: 'HTTP basic auth username',
+      description: '(HTTP drains) basic auth username',
     }),
     drainAPIKey: cliparse.option('api-key', {
       aliases: ['k'],
       metavar: 'api_key',
-      description: 'Drain custom key',
+      description: '(NewRelic drains) API key',
     }),
     drainIndexPrefix: cliparse.option('index-prefix', {
       aliases: ['i'],
       metavar: 'index_prefix',
-      description: 'Optional drain index prefix for ElasticSearch: `<indexPrefix>-<YYYY-MM-DD>`',
+      description: '(ElasticSearch drains) Index prefix',
       default: 'logstash-<YYYY-MM-DD>',
     }),
+    drainSDParameters: cliparse.option('sd-params', {
+      aliases: ['s'],
+      metavar: 'sd_params',
+      description: '(TCP and UDP drains) sd-params string (e.g.: `X-OVH-TOKEN=\\"REDACTED\\"`)',
+    }),
     verbose: cliparse.flag('verbose', { aliases: ['v'], description: 'Verbose output' }),
     withoutCache: cliparse.flag('without-cache', { description: 'Restart the application without using cache' }),
     confirmAddonCreation: cliparse.flag('yes', {
       aliases: ['y'],
-      description: 'Skip confirmation even if the addon is not free',
+      description: 'Skip confirmation even if the add-on is not free',
     }),
     confirmAddonDeletion: cliparse.flag('yes', {
       aliases: ['y'],
-      description: 'Skip confirmation and delete the addon directly',
+      description: 'Skip confirmation and delete the add-on directly',
     }),
     confirmApplicationDeletion: cliparse.flag('yes', {
       aliases: ['y'],
@@ -428,7 +433,7 @@ function run () {
       aliases: ['m'],
       required: true,
       metavar: 'member_id',
-      description: `The member ID: an app ID (e.g.: ${Formatter.formatCode('app_xxx')}), addon ID (e.g.: ${Formatter.formatCode('addon_xxx')}) or external node category ID`,
+      description: `The member ID: an app ID (e.g.: ${Formatter.formatCode('app_xxx')}), add-on ID (e.g.: ${Formatter.formatCode('addon_xxx')}) or external node category ID`,
       // complete: NetworkGroup('xxx'),
     }),
     ngMemberDomainName: cliparse.option('domain-name', {
@@ -579,37 +584,41 @@ function run () {
   // ADDON COMMANDS
   const addon = lazyRequirePromiseModule('../src/commands/addon.js');
   const addonCreateCommand = cliparse.command('create', {
-    description: 'Create an addon',
+    description: 'Create an add-on',
     args: [args.addonProvider, args.addonName],
     options: [opts.linkAddon, opts.confirmAddonCreation, opts.addonPlan, opts.addonRegion, opts.addonVersion, opts.addonOptions, opts.humanJsonOutputFormat],
   }, addon('create'));
   const addonDeleteCommand = cliparse.command('delete', {
-    description: 'Delete an addon',
+    description: 'Delete an add-on',
     args: [args.addonIdOrName],
     options: [opts.confirmAddonDeletion],
   }, addon('delete'));
   const addonRenameCommand = cliparse.command('rename', {
-    description: 'Rename an addon',
+    description: 'Rename an add-on',
     args: [args.addonIdOrName, args.addonName],
   }, addon('rename'));
   const addonShowProviderCommand = cliparse.command('show', {
-    description: 'Show information about an addon provider',
+    description: 'Show information about an add-on provider',
     args: [args.addonProvider],
   }, addon('showProvider'));
   const addonProvidersCommand = cliparse.command('providers', {
-    description: 'List available addon providers',
+    description: 'List available add-on providers',
     commands: [addonShowProviderCommand],
   }, addon('listProviders'));
   const addonEnvCommand = cliparse.command('env', {
-    description: 'List the environment variables for an addon',
+    description: 'List environment variables for an add-on',
     options: [opts.addonEnvFormat],
     args: [opts.addonId],
   }, addon('env'));
+  const addonListCommand = cliparse.command('list', {
+    description: 'List available add-ons',
+    options: [opts.humanJsonOutputFormat],
+  }, addon('list'));
 
   const addonCommands = cliparse.command('addon', {
-    description: 'Manage addons',
-    options: [opts.orgaIdOrName, opts.humanJsonOutputFormat],
-    commands: [addonCreateCommand, addonDeleteCommand, addonRenameCommand, addonProvidersCommand, addonEnvCommand],
+    description: 'Manage add-ons',
+    options: [opts.orgaIdOrName],
+    commands: [addonCreateCommand, addonDeleteCommand, addonRenameCommand, addonListCommand, addonProvidersCommand, addonEnvCommand],
   }, addon('list'));
 
   // APPLICATIONS COMMAND
@@ -713,7 +722,7 @@ function run () {
   const drainCreateCommand = cliparse.command('create', {
     description: 'Create a drain',
     args: [args.drainType, args.drainUrl],
-    options: [opts.addonId, opts.drainUsername, opts.drainPassword, opts.drainAPIKey, opts.drainIndexPrefix],
+    options: [opts.addonId, opts.drainUsername, opts.drainPassword, opts.drainAPIKey, opts.drainIndexPrefix, opts.drainSDParameters],
   }, drain('create'));
   const drainRemoveCommand = cliparse.command('remove', {
     description: 'Remove a drain',
@@ -821,11 +830,11 @@ function run () {
     options: [opts.ngIdOrLabel, opts.ngMemberId, opts.naturalName, opts.jsonFormat],
   }, networkgroups('getMember'));
   const networkGroupsMemberAddCommand = cliparse.command('add', {
-    description: 'Add an app or addon as a Network Group member',
+    description: 'Add an app or add-on as a Network Group member',
     options: [opts.ngIdOrLabel, opts.ngMemberId, opts.ngMemberType, opts.ngMemberDomainName, opts.optNgMemberLabel],
   }, networkgroups('addMember'));
   const networkGroupsMemberRemoveCommand = cliparse.command('remove', {
-    description: 'Remove an app or addon from a Network Group',
+    description: 'Remove an app or add-on from a Network Group',
     options: [opts.ngIdOrLabel, opts.ngMemberId],
   }, networkgroups('removeMember'));
 
@@ -954,11 +963,11 @@ function run () {
     args: [args.appIdOrName],
   }, service('unlinkApp'));
   const serviceLinkAddonCommand = cliparse.command('link-addon', {
-    description: 'Link an existing addon to this application',
+    description: 'Link an existing add-on to this application',
     args: [args.addonIdOrName],
   }, service('linkAddon'));
   const serviceUnlinkAddonCommand = cliparse.command('unlink-addon', {
-    description: 'Unlink an addon from this application',
+    description: 'Unlink an add-on from this application',
     args: [args.addonIdOrName],
   }, service('unlinkAddon'));
   const serviceCommands = cliparse.command('service', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
   "keywords": [

package/src/commands/addon.js

@@ -146,7 +146,7 @@ function displayAddon (format, addon, providerName, message) {
           colors.yellow(`/!\\ The MateriaDB ${providerName.toUpperCase()} provider is in Alpha testing phase, don't store sensitive or production grade data`),
           'You can easily use MateriaDB KV with \'redis-cli\', with such commands:',
           colors.blue(`source <(clever addon env ${addon.id} -F shell)`),
-          colors.blue('redis-cli -h $KV_HOST -p $KV_PORT'),
+          colors.blue('redis-cli -h $KV_HOST -p $KV_PORT --tls'),
         ].join('\n');
         Logger.println(materiaMessage);
       }

package/src/commands/drain.js

@@ -26,21 +26,24 @@ async function list (params) {
 
   drains.forEach((drain) => {
     const { id, state, target } = drain;
-    const { url, drainType, indexPrefix } = target;
+    const { url, drainType, indexPrefix, structuredDataParameters } = target;
 
     let drainView = `${id} -> ${state} for ${url} as ${drainType}`;
     if (indexPrefix != null) {
       drainView += `, index: '${indexPrefix}-<YYYY-MM-DD>'`;
     }
+    if (structuredDataParameters != null) {
+      drainView += `, sd-parameters: '${structuredDataParameters}'`;
+    }
     Logger.println(drainView);
   });
 }
 
 async function create (params) {
   const [drainTargetType, drainTargetURL] = params.args;
-  const { alias, addon: addonId, username, password, 'api-key': apiKey, 'index-prefix': indexPrefix } = params.options;
+  const { alias, addon: addonId, username, password, 'api-key': apiKey, 'index-prefix': indexPrefix, 'sd-parameters': structuredDataParameters } = params.options;
   const drainTargetCredentials = { username, password };
-  const drainTargetConfig = { apiKey, indexPrefix };
+  const drainTargetConfig = { apiKey, indexPrefix, structuredDataParameters };
 
   const appIdOrAddonId = await getAppOrAddonId({ alias, addonId });
   const body = createDrainBody(appIdOrAddonId, drainTargetURL, drainTargetType, drainTargetCredentials, drainTargetConfig);

package/src/models/drain.js

@@ -3,8 +3,8 @@
 const autocomplete = require('cliparse').autocomplete;
 
 const DRAIN_TYPES = [
-  { id: 'TCPSyslog' },
-  { id: 'UDPSyslog' },
+  { id: 'TCPSyslog', structuredDataParameters: 'OPTIONAL' },
+  { id: 'UDPSyslog', structuredDataParameters: 'OPTIONAL' },
   { id: 'HTTP', credentials: 'OPTIONAL' },
   { id: 'ElasticSearch', credentials: 'MANDATORY', indexPrefix: 'OPTIONAL' },
   { id: 'DatadogHTTP' },
@@ -33,6 +33,9 @@ function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCre
   if (indexPrefixExist(drainTargetConfig)) {
     body.indexPrefix = drainTargetConfig.indexPrefix;
   }
+  if (structuredDataParametersExist(drainTargetConfig)) {
+    body.structuredDataParameters = drainTargetConfig.structuredDataParameters;
+  }
   return body;
 }
 
@@ -42,6 +45,7 @@ function authorizeDrainCreation (drainTargetType, drainTargetCredentials, drainT
     const credStatus = fieldStatus(drainTargetType).credentials;
     const keyStatus = fieldStatus(drainTargetType).apiKey;
     const indexPrefixStatus = fieldStatus(drainTargetType).indexPrefix;
+    const structuredDataParametersStatus = fieldStatus(drainTargetType).structuredDataParameters;
 
     if (credStatus === 'MANDATORY') {
       return credentialsExist(drainTargetCredentials);
@@ -72,6 +76,16 @@ function authorizeDrainCreation (drainTargetType, drainTargetCredentials, drainT
     if (!indexPrefixStatus) {
       return indexPrefixEmpty(drainTargetConfig);
     }
+
+    if (structuredDataParametersStatus === 'MANDATORY') {
+      return structuredDataParametersExist(drainTargetConfig);
+    }
+    if (structuredDataParametersStatus === 'OPTIONAL') {
+      return true;
+    }
+    if (!structuredDataParametersStatus) {
+      return structuredDataParametersEmpty(drainTargetConfig);
+    }
   }
 }
 
@@ -99,6 +113,14 @@ function indexPrefixEmpty ({ indexPrefix }) {
   return indexPrefix == null;
 }
 
+function structuredDataParametersExist ({ structuredDataParameters }) {
+  return structuredDataParameters != null;
+}
+
+function structuredDataParametersEmpty ({ structuredDataParameters }) {
+  return structuredDataParameters == null;
+}
+
 function keyExist ({ apiKey }) {
   return apiKey != null;
 }