Commit 9be5ea0b authored by Michel Roy's avatar Michel Roy Committed by Kevin Di Lallo
Browse files

update meepctl doc

parent 8fa940b1

docs/meepctl/meepctl.md

+3 −1
Original line number Diff line number Diff line
@@ -20,12 +20,14 @@ 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 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

* [meepctl genmd](meepctl_genmd.md)	 - Generate markdown files for meepctl

* [meepctl publish](meepctl_publish.md)	 - Publish image on a registry

* [meepctl test](meepctl_test.md)	 - Generate code coverage report

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



###### Auto generated by spf13/cobra on 1-Apr-2019
 
###### Auto generated by spf13/cobra on 22-Apr-2019

docs/meepctl/meepctl_build.md

0 → 100644
+56 −0
Original line number Diff line number Diff line 
## meepctl build



Build core components



### Synopsis



Build core components



AdvantEDGE is composed of a collection of micro-services.



Build command genrates AdvantEDGE binaries.



Valid targets:

  * all

  * meep-frontend

  * meep-ctrl-engine

  * meep-initializer

  * meep-mg-manager

  * meep-mon-engine

  * meep-tc-engine

  * meep-tc-sidecar

  * meep-virt-engine



```

meepctl build <target> [flags]

```



### Examples



```

# Build all components

	meepctl build all

# Build meep-ctrl-engine component only

	meepctl build meep-ctrl-engine

		

```



### Options



```

      --codecov   Build a code coverage binary (dev. option)

  -h, --help      help for build

```



### Options inherited from parent commands



```

  -t, --time      Display timing information

  -v, --verbose   Display debug information

```



### SEE ALSO



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



###### Auto generated by spf13/cobra on 22-Apr-2019

docs/meepctl/meepctl_config.md

+6 −9
Original line number Diff line number Diff line
@@ -6,13 +6,10 @@ Config allows to manage meepctl configuration 


Config allows to manage meepctl configuration



meepctl relies on a configuration file that lives here $(HOME)/.meepctl.yaml

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



On first meepctl execution, it will be automatically created with default values

It then needs to be initialized by running the command shown in the example.



- IP is the IPV4 address of the local node where AdvantEDGE and meepctl are used

- gitdir is the path to the GIT directory of AdvantEDGE

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)





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



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

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

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



###### Auto generated by spf13/cobra on 1-Apr-2019
 
###### Auto generated by spf13/cobra on 22-Apr-2019

docs/meepctl/meepctl_config_set.md

+7 −7
Original line number Diff line number Diff line 
## meepctl config set



Set an individual value in the meepctl config file

Set value(s) in the meepctl config file



### Synopsis



Set an individual value in the meepctl config file

Set value(s) in the meepctl config file

	



```
@@ -15,11 +15,11 @@ meepctl config set [flags] 


```

  # Configure IP address

    meep config set --ip 1.2.3.4

    meepctl config set --ip 1.2.3.4

  # Configure GIT directory

    meep config set --gitdir /home/some-user/AdvantEDGE

    meepctl config set --gitdir /home/some-user/AdvantEDGE

  # Configure GIT to local directory + IP simultaneously

    meepctl config set --gitdir $(pwd) --ip 1.2.3.4

    meepctl config set --gitdir /home/some-user/AdvantEDGE --ip 1.2.3.4

	

```
@@ -28,7 +28,7 @@ meepctl config set [flags] 
```

      --gitdir string   Path to the AdvantEDGE GIT directory

  -h, --help            help for set

      --ip string       IP address of the AdvantEDGE node (local IP address)

      --ip string       IP address of AdvantEDGE node (local IP address)

```



### Options inherited from parent commands
@@ -42,4 +42,4 @@ meepctl config set [flags] 


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



###### Auto generated by spf13/cobra on 1-Apr-2019
 
###### Auto generated by spf13/cobra on 22-Apr-2019

docs/meepctl/meepctl_delete.md

+3 −3
Original line number Diff line number Diff line
@@ -24,9 +24,9 @@ meepctl delete <group> [flags] 


```

  # Delete all containers

    meep delete all

    meepctl delete all

  # Delete only AdvantEDGE core containers

    meep delete core

    meepctl delete core

			

```
@@ -47,4 +47,4 @@ meepctl delete <group> [flags] 


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



###### Auto generated by spf13/cobra on 1-Apr-2019
 
###### Auto generated by spf13/cobra on 22-Apr-2019