github.com/pluralsh/plural-cli@v0.9.5/README.md (about)

     1  # Plural CLI
     2  
     3  The plural cli automates all gitops operations for your deployments of plural applications.  The core workflow should mostly be as simple as:
     4  
     5  ```bash
     6  plural build
     7  plural deploy
     8  ```
     9  
    10  And if you want to teardown your infrastructure, you can simply run:
    11  
    12  ```bash
    13  plural destroy
    14  ```
    15  
    16  To add, update or reconfigure any applications deployed by plural.  But it goes even deeper and solves things like:
    17  
    18  * Secret management (via a similar mechanism as git-crypt)
    19  * Application Health checking - `plural watch APP`
    20  * Log tailing - `plural logs list APP` and `plural logs tail APP LOGSTREAM`
    21  * Setting up secure proxies into databases, private web UIs - `plural proxy list APP` and `plural proxy connect APP NAME`
    22  
    23  ## Installation
    24  
    25  There are a number of means to install plural, the simplest is to use our homebrew tap if you're using mac:
    26  
    27  ```bash
    28  brew install pluralsh/plural/plural
    29  ```
    30  
    31  More detailed instructions for other platforms can be found at https://docs.plural.sh/getting-started#1.-install-plural-cli-and-dependencies
    32  
    33  Plural does require a few other cli's to be installed, namely:
    34  * helm
    35  * terraform
    36  * kubectl
    37  * cloud provider cli for the infrastructure you're deploying to, like `awscli`, `gcloud`, etc
    38  * [kind](https://kind.sigs.k8s.io/) if using kind to deploy a local cluster for testing
    39  
    40  ## Setup
    41  
    42  The core workflow is all git based, so you should create a git repository on github or wherever you're using SCM, clone it locally, then run:
    43  
    44  ```bash
    45  plural init
    46  ```
    47  
    48  You'll want to then install a bundle for whatever application you'd like, we'll use https://github.com/airbytehq/airbyte as an example.  You can search for the bundles using:
    49  
    50  
    51  ```bash
    52  plural bundle list airbyte
    53  ```
    54  
    55  And chose one (using aws as an example cloud provider target) like:
    56  
    57  ```bash
    58  plural bundle install airbyte airbyte-aws
    59  ```
    60  
    61  This will set the basic configuration parameters for all the infrastructure needed to install airbyte.  Then just run:
    62  
    63  ```bash
    64  plural build
    65  plural deploy --commit "deploying my first plural app!"
    66  ```
    67  
    68  To install it.
    69  
    70  
    71  ## Installing the Plural Console
    72  
    73  We highly recommend installing the [plural console](https://github.com/pluralsh/console) alongside your plural applications.  That can be done easily with:
    74  
    75  ```bash
    76  plural bundle install console console-aws
    77  plural build
    78  plural deploy --commit "deploying the plural console"
    79  ```
    80  
    81  ## Reaching Out
    82  
    83  If you have any issues with your plural installations, or just want to show us some love, feel free to drop into our discord [here](https://discord.gg/bEBAMXV64s)