Skip to content
This repository has been archived by the owner on Feb 15, 2022. It is now read-only.

Commit

Permalink
Added remove() docs (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
evanlouie authored Jun 20, 2019
1 parent 6a4bd63 commit 81e8077
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Adds a subcomponent to the current component (or the component specified by the
$ fab add <component-name> --source <component-source> [--type component] [--method git] [--path .]
```

Where:
Where:

* `source` specifies where the component lives (either a local path or remote http(s) endpoint)
* `type` specifies the type of component (`component` (default), `helm`, or `static`)
* `method` specifies the method that should be used to fetch the component (`git` (default))
* `path` specifies the path to the component that this subcomponent should be added to.
- `source` specifies where the component lives (either a local path or remote http(s) endpoint)
- `type` specifies the type of component (`component` (default), `helm`, or `static`)
- `method` specifies the method that should be used to fetch the component (`git` (default))
- `path` specifies the path to the component that this subcomponent should be added to.

### Example

Expand All @@ -34,7 +34,7 @@ $ fab generate <config1> <config2> ... <configN>
```

Where the generate command takes a list of the configurations that should be used to generate the resource
definitions for the deployment. These configurations should be specified in priority order. For example,
definitions for the deployment. These configurations should be specified in priority order. For example,
if you specified `prod azure east`, `prod`'s config would be applied first, and `azure`'s config
would only be applied if they did not conflict with `prod`. Likewise, `east`'s config would only be applied
if it did not conflict with `prod` or `azure`.
Expand All @@ -47,8 +47,8 @@ $ fab generate prod azure east

## install

Installs all of the remote components specified in the current deployment tree locally, iterating the
component subtree from the current directory to do so. Required to be executed before generate (if needed), such
Installs all of the remote components specified in the current deployment tree locally, iterating the
component subtree from the current directory to do so. Required to be executed before generate (if needed), such
that Fabrikate has all of the dependencies locally to use to generate the resource manifests.

#### Example
Expand All @@ -57,6 +57,22 @@ that Fabrikate has all of the dependencies locally to use to generate the resour
$ fab install
```

## remove

Removes a subcomponent from the current component.

### Usage

```sh
$ fab remove <subcomponent-name>
```

### Examples

```sh
$ fab remove cloud-native
```

## set

Sets a config value for a component for a particular config environment in the Fabrikate definition.
Expand All @@ -76,13 +92,13 @@ $ fab set --environment prod data.replicas=4 username="ops"
Sets the value of 'data.replicas' equal to 4 and 'username' equal to 'ops' in the 'prod' config for the current component.

```sh
$ fab set --subcomponent "myapp" endpoint="east-db"
$ fab set --subcomponent "myapp" endpoint="east-db"
```

Sets the value of 'endpoint' equal to 'east-db' in the 'common' config (the default) for subcomponent 'myapp'.

```sh
$ fab set --subcomponent "myapp.mysubcomponent" data.replicas=5
$ fab set --subcomponent "myapp.mysubcomponent" data.replicas=5
```

Sets the subkey "replicas" in the key 'data' equal to 5 in the 'common' config (the default) for the subcomponent 'mysubcomponent' of the subcomponent 'myapp', but raises an error via the --no-new-config-keys switch if doing so would create new config.
Expand Down

0 comments on commit 81e8077

Please sign in to comment.