Commit 38a099ab authored by Michel Roy's avatar Michel Roy Committed by Kevin Di Lallo
Browse files

update meepctl doc

parent 9f4befcc

docs/meepctl/meepctl.md

+2 −2
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ meepctl - CLI application to control the AdvantEDGE platform 
### SEE ALSO



* [meepctl build](meepctl_build.md)	 - Build core components

* [meepctl config](meepctl_config.md)	 - Config allows to manage meepctl configuration

* [meepctl config](meepctl_config.md)	 - Config allows to manage meep environment configuration

* [meepctl delete](meepctl_delete.md)	 - Delete containers from the K8s cluster

* [meepctl deploy](meepctl_deploy.md)	 - Deploy containers on the K8s cluster

* [meepctl dockerize](meepctl_dockerize.md)	 - Dockerize core components
@@ -30,4 +30,4 @@ meepctl - CLI application to control the AdvantEDGE platform 
* [meepctl test](meepctl_test.md)	 - Generate code coverage report

* [meepctl version](meepctl_version.md)	 - Display version information



###### Auto generated by spf13/cobra on 30-Apr-2019
 
###### Auto generated by spf13/cobra on 15-May-2019

docs/meepctl/meepctl_build.md

+1 −1
Original line number Diff line number Diff line
@@ -54,4 +54,4 @@ meepctl build <target> [flags] 


* [meepctl](meepctl.md)	 - meepctl - CLI application to control the AdvantEDGE platform



###### Auto generated by spf13/cobra on 30-Apr-2019
 
###### Auto generated by spf13/cobra on 15-May-2019

docs/meepctl/meepctl_config.md

+8 −4
Original line number Diff line number Diff line 
## meepctl config



Config allows to manage meepctl configuration

Config allows to manage meep environment configuration



### Synopsis



Config allows to manage meepctl configuration

Config allows to manage meep environment configuration



meepctl relies on a configuration file that lives here ~/.meepctl.yaml



On first meepctl execution, the configuration file is created with default values

It then needs to be initialized once by running initial configuration command (below)

It then needs to be initialized once by running initial configuration command (below).

It also manages dashboards and configuration items present in Kibana.





```
@@ -23,6 +24,8 @@ meepctl config [flags] 
 meepctl config set --ip <your-node-ip> --gitdir <path-to-advantedge-git-dir>

 # Help on set command

 meepctl config set --help

 # Help on kibana command

 meepctl config kibana --help

```



### Options
@@ -41,6 +44,7 @@ meepctl config [flags] 
### SEE ALSO



* [meepctl](meepctl.md)	 - meepctl - CLI application to control the AdvantEDGE platform

* [meepctl config kibana](meepctl_config_kibana.md)	 - Configures Kibana (index pattern, saved objects such as dashboards, visualisations, etc.)

* [meepctl config set](meepctl_config_set.md)	 - Set value(s) in the meepctl config file



###### Auto generated by spf13/cobra on 30-Apr-2019
 
###### Auto generated by spf13/cobra on 15-May-2019

docs/meepctl/meepctl_config_kibana.md

0 → 100644
+39 −0
Original line number Diff line number Diff line 
## meepctl config kibana



Configures Kibana (index pattern, saved objects such as dashboards, visualisations, etc.)



### Synopsis



Configures Kibana (index pattern, saved objects such as dashboards, visualisations, etc.)

        



```

meepctl config kibana [flags]

```



### Examples



```

  # Configure Kibana by downloading saved objects (dashboards, visualizations, etc) and applying a default index pattern

  # NOTE: Any Kibana saved object will be overwritten in the process if the object Id are the same 

    meepctl config kibana.

```



### Options



```

  -h, --help   help for kibana

```



### Options inherited from parent commands



```

  -t, --time      Display timing information

  -v, --verbose   Display debug information

```



### SEE ALSO



* [meepctl config](meepctl_config.md)	 - Config allows to manage meep environment configuration



###### Auto generated by spf13/cobra on 15-May-2019

docs/meepctl/meepctl_config_set.md

+2 −2
Original line number Diff line number Diff line
@@ -40,6 +40,6 @@ meepctl config set [flags] 


### SEE ALSO



* [meepctl config](meepctl_config.md)	 - Config allows to manage meepctl configuration

* [meepctl config](meepctl_config.md)	 - Config allows to manage meep environment configuration



###### Auto generated by spf13/cobra on 30-Apr-2019
 
###### Auto generated by spf13/cobra on 15-May-2019