Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sami-alajrami committed Oct 13, 2021
1 parent f958798 commit a1faf36
Show file tree
Hide file tree
Showing 9 changed files with 71 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/merkely.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ Environment variables:
* [merkely report](merkely_report.md) - Report compliance events to Merkely.
* [merkely version](merkely_version.md) - Print the client version information

###### Auto generated by spf13/cobra on 7-Sep-2021
###### Auto generated by spf13/cobra on 13-Oct-2021
2 changes: 1 addition & 1 deletion docs/merkely_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Report compliance events back to Merkely.
* [merkely](merkely.md) - The Merkely evidence reporting CLI.
* [merkely report env](merkely_report_env.md) - Report running artifacts in an environment to Merkely.

###### Auto generated by spf13/cobra on 7-Sep-2021
###### Auto generated by spf13/cobra on 13-Oct-2021
5 changes: 3 additions & 2 deletions docs/merkely_report_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This allows Merkely to determine Runtime compliance status of the environment.

* [merkely report](merkely_report.md) - Report compliance events to Merkely.
* [merkely report env ecs](merkely_report_env_ecs.md) - Report images data from AWS ECS cluster to Merkely.
* [merkely report env k8s](merkely_report_env_k8s.md) - Report images data from specific namespace or entire cluster to Merkely.
* [merkely report env k8s](merkely_report_env_k8s.md) - Report images data from specific namespace(s) or entire cluster to Merkely.
* [merkely report env server](merkely_report_env_server.md) - Report directory artifacts data in the given list of paths to Merkely.

###### Auto generated by spf13/cobra on 7-Sep-2021
###### Auto generated by spf13/cobra on 13-Oct-2021
3 changes: 2 additions & 1 deletion docs/merkely_report_env_ecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ merkely report env ecs prod --api-token 1234 --owner exampleOrg
```
-C, --cluster string name of the ECS cluster
-h, --help help for ecs
-i, --id string the unique identifier of the source infrastructure of the report (e.g. the ECS cluster/service name).If not set, it is defaulted based on the following order: --service-name, --cluster, environment name.
-s, --service-name string name of the ECS service
```

Expand All @@ -45,4 +46,4 @@ merkely report env ecs prod --api-token 1234 --owner exampleOrg

* [merkely report env](merkely_report_env.md) - Report running artifacts in an environment to Merkely.

###### Auto generated by spf13/cobra on 7-Sep-2021
###### Auto generated by spf13/cobra on 13-Oct-2021
13 changes: 7 additions & 6 deletions docs/merkely_report_env_k8s.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## merkely report env k8s

Report images data from specific namespace or entire cluster to Merkely.
Report images data from specific namespace(s) or entire cluster to Merkely.

### Synopsis

Expand All @@ -10,15 +10,15 @@ and report them to Merkely.


```
merkely report env k8s [-n namespace | -x namespace]... [-k /path/to/kube/config] env-name [flags]
merkely report env k8s [-n namespace | -x namespace]... [-k /path/to/kube/config] [-i infrastructure-identifier] env-name [flags]
```

### Examples

```
* report what's running in an entire cluster using kubeconfig at $HOME/.kube/config:
merkely report env k8s prod --api-token 1234 --owner exampleOrg
merkely report env k8s prod --api-token 1234 --owner exampleOrg --id prod-cluster
* report what's running in an entire cluster using kubeconfig at $HOME/.kube/config
(with global flags defined in environment or in a config file):
Expand All @@ -38,10 +38,11 @@ merkely report env k8s prod -k /path/to/kube/config
### Options

```
-x, --exclude-namespace strings the comma separated list of namespaces (or namespaces regex patterns) NOT to harvest artifacts info from. Can't be used together with --namespace.
-x, --exclude-namespace strings the comma separated list of namespaces regex patterns NOT to report artifacts info from. Can't be used together with --namespace.
-h, --help help for k8s
-i, --id string the unique identifier of the source infrastructure of the report (e.g. the K8S cluster/namespace name). If not set, it is defaulted to environment name.
-k, --kubeconfig string kubeconfig path for the target cluster
-n, --namespace strings the comma separated list of namespaces (or namespaces regex patterns) to harvest artifacts info from. Can't be used together with --exclude-namespace.
-n, --namespace strings the comma separated list of namespaces regex patterns to report artifacts info from. Can't be used together with --exclude-namespace.
```

### Options inherited from parent commands
Expand All @@ -59,4 +60,4 @@ merkely report env k8s prod -k /path/to/kube/config

* [merkely report env](merkely_report_env.md) - Report running artifacts in an environment to Merkely.

###### Auto generated by spf13/cobra on 7-Sep-2021
###### Auto generated by spf13/cobra on 13-Oct-2021
48 changes: 48 additions & 0 deletions docs/merkely_report_env_server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## merkely report env server

Report directory artifacts data in the given list of paths to Merkely.

### Synopsis


List the artifacts deployed in a server environment and their digests
and report them to Merkely.


```
merkely report env server [-p /path/of/artifacts/directory] [-i infrastructure-identifier] env-name [flags]
```

### Examples

```
* report directory artifacts running in a server at a list of paths:
merkely report env server prod --api-token 1234 --owner exampleOrg --id prod-server --paths a/b/c, e/f/g
```

### Options

```
-h, --help help for server
-i, --id string the unique identifier of the source infrastructure of the report (e.g. the K8S cluster/namespace name). If not set, it is defaulted to environment name.
-p, --paths strings the comma separated list of artifact directories.
```

### Options inherited from parent commands

```
-a, --api-token string the merkely API token.
-c, --config-file string [optional] the merkely config file path. (default "merkely")
-d, --dry-run whether to send the request to the endpoint or just log it in stdout.
-H, --host string the merkely endpoint. (default "https://app.merkely.com")
-r, --max-api-retries int how many times should API calls be retried when the API host is not reachable. (default 3)
-o, --owner string the merkely organization.
```

### SEE ALSO

* [merkely report env](merkely_report_env.md) - Report running artifacts in an environment to Merkely.

###### Auto generated by spf13/cobra on 13-Oct-2021
2 changes: 1 addition & 1 deletion docs/merkely_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ merkely version [flags]

* [merkely](merkely.md) - The Merkely evidence reporting CLI.

###### Auto generated by spf13/cobra on 7-Sep-2021
###### Auto generated by spf13/cobra on 13-Oct-2021
3 changes: 3 additions & 0 deletions docs/rst/merkely_report_env_ecs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
* - MERKELY_HOST
- no
- the merkely endpoint. Defaults to :code:`https://app.merkely.com`.
* - MERKELY_ID
- yes
- the unique identifier of the source infrastructure of the report (e.g. the ECS cluster/service name).If not set, it is defaulted based on the following order: --service-name, --cluster, environment name.
* - MERKELY_MAX_API_RETRIES
- no
- how many times should API calls be retried when the API host is not reachable. Defaults to :code:`3`.
Expand Down
7 changes: 5 additions & 2 deletions docs/rst/merkely_report_env_k8s.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@
- whether to send the request to the endpoint or just log it in stdout. Defaults to :code:`false`.
* - MERKELY_EXCLUDE_NAMESPACE
- no
- the comma separated list of namespaces (or namespaces regex patterns) NOT to harvest artifacts info from. Can't be used together with --namespace. Defaults to :code:`[]`.
- the comma separated list of namespaces regex patterns NOT to report artifacts info from. Can't be used together with --namespace. Defaults to :code:`[]`.
* - MERKELY_HOST
- no
- the merkely endpoint. Defaults to :code:`https://app.merkely.com`.
* - MERKELY_ID
- yes
- the unique identifier of the source infrastructure of the report (e.g. the K8S cluster/namespace name). If not set, it is defaulted to environment name.
* - MERKELY_KUBECONFIG
- yes
- kubeconfig path for the target cluster
Expand All @@ -27,7 +30,7 @@
- how many times should API calls be retried when the API host is not reachable. Defaults to :code:`3`.
* - MERKELY_NAMESPACE
- no
- the comma separated list of namespaces (or namespaces regex patterns) to harvest artifacts info from. Can't be used together with --exclude-namespace. Defaults to :code:`[]`.
- the comma separated list of namespaces regex patterns to report artifacts info from. Can't be used together with --exclude-namespace. Defaults to :code:`[]`.
* - MERKELY_OWNER
- yes
- the merkely organization.

0 comments on commit a1faf36

Please sign in to comment.