clever-tools 3.0.2 → 3.2.0

package/README.md

@@ -1,216 +1,41 @@
-# clever-tools
+# Clever Tools
 
-[![Build Status](https://travis-ci.org/CleverCloud/clever-tools.svg?branch=master)](https://travis-ci.org/CleverCloud/clever-tools)
-
-Command Line Interface for Clever Cloud.
+Deploy on Clever Cloud and control you applications, add-ons, services from command line.
 
 ## Installation
 
-The clever-tools CLI can be installed through many channels depending on your system setup.
-
-### Via npm
-
-If you already have node/npm on your system, you can run:
+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:
 
 ```sh
 npm install -g clever-tools
 ```
 
-If you want to install our latest beta release, you can run:
-
-```sh
-npm install -g clever-tools@beta
-```
-
-### On GNU/Linux
-
-#### Debian/Ubuntu (.deb)
-
----
-
-##### Warning
-
-We recently moved from Bintray to a self-hosted Nexus repository available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
-If you were using Bintray to install our `.deb` packages, you will need to edit your `/etc/apt/sources.list` and remove the old entry with `https://dl.bintray.com/clevercloud/deb` before going further.
-
----
-
-If you are using a GNU/Linux distribution that uses `.deb` packages like Debian or Ubuntu, you can run:
-
-```sh
-curl -fsSL https://clever-tools.clever-cloud.com/gpg/cc-nexus-deb.public.gpg.key | gpg --dearmor -o /usr/share/keyrings/cc-nexus-deb.gpg
-echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/cc-nexus-deb.gpg] https://nexus.clever-cloud.com/repository/deb stable main" | tee -a /etc/apt/sources.list
-apt-get update
-apt-get install clever-tools
-```
-
-NOTES:
-
-* The `.deb` packages are hosted on Clever Cloud's public Nexus instance available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
-* Our PGP key is required to trust the repository.
-* If you want access to the beta channel, you can use this in your `sources.list`:
-
-```sh
-echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/cc-nexus-deb.gpg] https://nexus.clever-cloud.com/repository/deb-beta beta main" | tee -a /etc/apt/sources.list
-```
-
-#### CentOS/Fedora (.rpm)
-
----
-
-##### Warning
-
-We recently moved from Bintray to a self-hosted Nexus repository available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
-If you were using Bintray to install our `.rpm` packages, you will need to remove the old `/etc/yum.repos.d/bintray-clevercloud-rpm.repo` before going further.
-
----
-
-If you are using a GNU/Linux distribution that uses `.rpm` packages like CentOS or Fedora, you can run:
-
-```sh
-curl -s https://clever-tools.clever-cloud.com/repos/cc-nexus-rpm.repo > /etc/yum.repos.d/cc-nexus-rpm.repo
-yum update
-yum install clever-tools
-```
-
-NOTES:
+We also distribute binaries and packages for multiple systems and tools:
 
-* The `.rpm` packages are hosted on Clever Cloud's public Nexus instance available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
-* If you want access to the beta channel, you will need to edit `/etc/yum.repos.d/cc-nexus-rpm.repo` and set `enabled=1` for the `[clever-tools-beta]`.
-
-#### Arch Linux
-
-If you are using Arch Linux, the packages can be installed from AUR with this repo: [clever-tools-bin](https://aur.archlinux.org/packages/clever-tools-bin/).
-If you don't know how to use this, you can run:
-
-```sh
-git clone https://aur.archlinux.org/clever-tools-bin.git clever-tools
-cd clever-tools
-makepkg -si
-```
-
-NOTES:
-
-* If you want access to the beta channel, you can use this repo [clever-tools-bin-beta](https://aur.archlinux.org/packages/clever-tools-bin-beta/).
-
-#### Exherbo
-
-If you are using Exherbo, you can run:
-
-```sh
-cave resolve repository/CleverCloud -zx1
-cave resolve clever-tools-bin -zx
-```
-
-#### Other distributions (.tar.gz)
-
-If you are using another GNU/Linux distribution, you can download a `.tar.gz` archive and extract the binary in your `PATH`:
-
-```sh
-curl -O https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_linux.tar.gz
-tar xvzf clever-tools-latest_linux.tar.gz
-cp clever-tools-latest_linux/clever ~/.local/bin/
-```
-
-NOTES:
-
-* The packages are available on Clever Cloud's Cellar bucket: [clever-tools-latest_linux.tar.gz](https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_linux.tar.gz).
-* You can also retrieve any release (including beta) on this Cellar bucket by replacing `latest` (path and filename) with the version number you need.
-
-### On macOS
-
-#### Using homebrew
-
-If you are using macOS and you have [homebrew](https://brew.sh) installed, you can run:
-
-```sh
-brew install CleverCloud/homebrew-tap/clever-tools
-```
-
-NOTES:
-
-* If you want access to the beta channel, you can use `CleverCloud/homebrew-tap-beta/clever-tools` instead.
-
-#### Using the `.tar.gz` archive
-
-If you are using macOS, but you don't have [homebrew](https://brew.sh) installed, you can download a `.tar.gz` archive and extract the binary in your `PATH`:
-
-```sh
-curl -O https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_macos.tar.gz
-tar xvzf clever-tools-latest_macos.tar.gz
-cp clever-tools-latest_macos/clever ~/.local/bin/
-```
-
-NOTES:
-
-* The packages are available on Clever Cloud's Cellar bucket: [clever-tools-latest_macos.tar.gz](https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_macos.tar.gz).
-* You can also retrieve any release (including beta) on this Cellar bucket by replacing `latest` (path and filename) with the version number you need.
-
-### On Windows
-
-#### Using chocolatey
-
----
-
-##### Warning
-
-We recently moved from Bintray to a self-hosted Nexus repository available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
-If you were using Bintray to install our `.nupkg` packages, you will need to remove the old source.
-
----
-
-If you are using Windows and you have [chocolatey](https://chocolatey.org) installed, you can run:
-
-```bash
-choco sources add -n=clevercloud -s='https://nexus.clever-cloud.com/repository/nupkg/'
-choco install clever-tools
-```
-
-NOTES:
-
-* If you want access to the beta channel, you can use `choco sources add -n=clevercloud -s='https://nexus.clever-cloud.com/repository/nupkg-beta/'` instead.
-
-#### Using the `.zip` archive
-
-If you are using Windows, but you don't have [chocolatey](https://chocolatey.org) installed, you can download a `.zip` archive and extract the binary in your `PATH`.
-
-NOTES:
-
-* The packages are available on Clever Cloud's Cellar bucket: [clever-tools-latest_win.tar.gz](https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_win.zip).
-* You can also retrieve any release (including beta) on this Cellar bucket by replacing `latest` (path and filename) with the version number you need.
-
-### Via Docker
-
-If you are using docker, you can use the image provided [here](https://hub.docker.com/r/clevercloud/clever-tools/).
-
-```sh
-docker pull clevercloud/clever-tools
-docker run --rm clever-tools <command>
-```
-
-#### Dockerfile
-
-In your `Dockerfile` you can copy the clever-tools CLI from the image itself with a simple one liner:
-
-```Dockerfile
-COPY --from=clevercloud/clever-tools /bin/clever /usr/local/bin/clever
-```
-
-### Via Nix
-
-If you are using Nix, you will find a Nix derivation on Fretlink's GitHub repository: https://github.com/fretlink/clever-tools-nix
+* [GNU/Linux](docs/setup-systems.md#gnulinux)
+  * [Arch Linux (AUR)](docs/setup-systems.md#arch-linux-aur)
+  * [CentOS/Fedora (.rpm)](docs/setup-systems.md#centosfedora-rpm)
+  * [Debian/Ubuntu (.deb)](docs/setup-systems.md#debianubuntu-deb)
+  * [Exherbo](docs/setup-systems.md#exherbo)
+  * [Binary (.tar.gz)](docs/setup-systems.md#other-distributions-targz)
+* [macOS](docs/setup-systems.md#macos)
+  * [Homebrew](docs/setup-systems.md#homebrew)
+  * [Binary (.tar.gz)](docs/setup-systems.md#binary-zip)
+* [Windows](docs/setup-systems.md#windows)
+  * [Chocolatey](docs/setup-systems.md#chocolatey)
+  * [Binary (.zip)](docs/setup-systems.md#binary-zip)
+* [Docker](docs/setup-systems.md#docker)
+* [Nix](docs/setup-systems.md#nix-package-manager)
 
 ## Enabling autocompletion
 
-The clever-tools CLI comes with a comprehensive auto-completion system.
-Some installation methods like `.deb` packages, `.rpm` packages or brew will try to enable it automatically.
-If it does not work, try this for bash:
+The clever-tools CLI comes with a comprehensive auto-completion system. Some installation methods through package managers will try to enable it automatically. If not, use this for bash:
 
 ```bash
 clever --bash-autocomplete-script $(which clever) | sudo tee /usr/share/bash-completion/completions/clever
 ```
 
-or this for zsh:
+or that for zsh:
 
 ```bash
 clever --zsh-autocomplete-script $(which clever) | sudo tee /usr/share/zsh/site-functions
@@ -248,7 +73,8 @@ Where `type` is one of:
 - `haskell`: for haskell applications
 - `jar`: for applications deployed as standalone jar files
 - `maven`: for applications launched with maven
-- `node`: for node.js applications
+- `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
@@ -261,11 +87,17 @@ Where `type` is one of:
 
 Where region is one of:
 
-- `par` (for Paris)
-- `mtl` (for Montreal)
+- `par` (Paris, [Clever Cloud](https://www.clever-cloud.com/infrastructure/))
+- `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/))
+- `jed` (Jeddah, Oracle Cloud)
+- `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.
+`--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, …)
 
@@ -300,61 +132,6 @@ clever status [--alias <alias>]
 clever scale [--alias <alias>] [--min-flavor <minflavor>] [--max-flavor <maxflavor>] [--min-instances <mininstances>] [--max-instances <maxinstances>]
 ```
 
-### Logs Drains
-
-```sh
-# create drain
-clever drain create [--alias <alias>] <DRAIN-TYPE> <DRAIN-URL> [--username <username>] [--password <password>]
-```
-
-```sh
-# list drains
-clever drain [--alias <alias>]
-```
-
-```sh
-# remove drain
-clever drain remove [--alias <alias>] <DRAIN-ID>
-```
-
-Where `DRAIN-TYPE` is one of:
-
-- `TCPSyslog`: for TCP syslog endpoint;
-- `UDPSyslog`: for UDP syslog endpoint;
-- `HTTP`: for TCP syslog endpoint (note that this endpoint has optional username/passwordparameters as HTTP Basic Authentication);
-- `ElasticSearch`: for ElasticSearch endpoint (note that this endpoint requires username/password parameters as HTTP Basic Authentication);
-- `DatadogHTTP`: for Datadog endpoint (note that this endpoint needs your Datadog API Key).
-- `NewRelicHTTP`: for NewRelic endpoint (note that this endpoint needs your NewRelic API Key).
-
-#### ElasticSearch logs drains
-
-ElasticSearch drains use the Elastic bulk API. To match this endpoint, specify `/_bulk` at the end of your ElasticSearch endpoint.
-
-#### Datadog logs drains
-
-Datadog has two zones, EU and COM. An account on one zone is not available on the other, make sure to target the good EU or COM intake endpoint.
-
-To create a [Datadog](https://docs.datadoghq.com/api/?lang=python#send-logs-over-http) drain, you just need to use one of the following command depending on your zone:
-
-```sh
-# EU
-clever drain create DatadogHTTP "https://http-intake.logs.datadoghq.eu/v1/input/<API_KEY>?ddsource=clevercloud&service=<SERVICE>&host=<HOST>"
-# US
-clever drain create DatadogHTTP "https://http-intake.logs.datadoghq.com/v1/input/<API_KEY>?ddsource=clevercloud&service=<SERVICE>&host=<HOST>"
-```
-
-Please note that the `host` query parameter is not mandatory: in the Datadog pipeline configuration, you can map `@source_host` which is the host provided by Clever Cloud in logs as `host` property.
-
-#### NewRelic logs drains
-
-NewRelic has two zones, EU and US. An account on one zone is not available on the other, make sure to target the good EU or US intake endpoint.
-
-To create a [NewRelic](https://docs.newrelic.com/docs/logs/log-api/introduction-log-api/) drain, you just need to use:
-
-```sh
-clever drain create NewRelicHTTP "https://log-api.eu.newrelic.com/log/v1" --api-key <API_KEY>
-```
-
 ### Display help
 
 You can display help about each command with `clever help`.
@@ -377,11 +154,7 @@ clever deploy
 
 [Send us an email!](mailto:support@clever-cloud.com) or [submit an issue](https://github.com/CleverCloud/clever-tools/issues).
 
-## Automated testing
-
-This project uses Travis CI to launch unit tests and validate pull requests before they're merged: https://travis-ci.org/CleverCloud/clever-tools
-
 ## Automated releases
 
-This project uses Jenkins to build binaries, package them and release them automatically on the various repositories.
+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.