updated meepctl documentation (daf10cad) · Commits · MEC - Multi-access Edge Computing / ETSI MEC Sandbox

docs/meepctl/meepctl.md

+4 −8

Original line number	Diff line number	Diff line
		@@ -4,12 +4,9 @@ meepctl - CLI application to control the AdvantEDGE platform

		### Synopsis


		meepctl - CLI application to control the AdvantEDGE platform

		CLI application to control the AdvantEDGE platform
		Find more information [here](https://kopsvas19p.interdigital.com/wbu-tep/AdvantEDGE/blob/develop/docs/meepctl/meepctl.md)


		### Options

		```
		@@ -21,13 +18,12 @@ 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 meep environment configuration
		* [meepctl config](meepctl_config.md) - 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
		* [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 15-May-2019
		###### Auto generated by spf13/cobra on 17-Jun-2019

docs/meepctl/meepctl_build.md

+8 −10

Original line number	Diff line number	Diff line
		@@ -4,11 +4,10 @@ Build core components

		### Synopsis

		Build core components

		AdvantEDGE is composed of a collection of micro-services.

		Build command genrates AdvantEDGE binaries.
		Build command generates AdvantEDGE binaries.
		Multiple targets can be specified (e.g. meepctl build <target1> <target2>...)

		Valid targets:
		* all
		@@ -22,7 +21,7 @@ Valid targets:
		* meep-virt-engine

		```
		meepctl build <target> [flags]
		meepctl build <targets> [flags]
		```

		### Examples
		@@ -32,7 +31,6 @@ meepctl build <target> [flags]
		meepctl build all
		# Build meep-ctrl-engine component only
		meepctl build meep-ctrl-engine

		```

		### Options
		@@ -54,4 +52,4 @@ meepctl build <target> [flags]

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

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

docs/meepctl/meepctl_config.md

+9 −21

Original line number	Diff line number	Diff line
		## meepctl config

		Config allows to manage meep environment configuration
		manage meep environment configuration

		### Synopsis

		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 also manages dashboards and configuration items present in Kibana.
		Get/Set meep environment configuration.
		Config file location: ~/.meepctl.yaml

		Config file is created with default values if it does not already exist.
		Values may be changed using the available commands described below.

		```
		meepctl config [flags]
		```

		### Examples

		```
		# Initial configuration
		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

		```
		@@ -44,7 +30,9 @@ meepctl config [flags]
		### SEE ALSO

		* [meepctl](meepctl.md) - meepctl - CLI application to control the AdvantEDGE platform
		* [meepctl config gitdir](meepctl_config_gitdir.md) - get/set GIT directory path in the meepctl config file
		* [meepctl config ip](meepctl_config_ip.md) - get/get node IP address in the meepctl config file
		* [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
		* [meepctl config registry](meepctl_config_registry.md) - get/get docker registry meepctl config file

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

docs/meepctl/meepctl_config_gitdir.md

0 → 100644

+36 −0

Original line number	Diff line number	Diff line
		## meepctl config gitdir

		get/set GIT directory path in the meepctl config file

		### Synopsis

		Get/Set GIT directory path in the meepctl config file

		```
		meepctl config gitdir [GIT dir path] [flags]
		```

		### Examples

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

		### Options

		```
		-h, --help help for gitdir
		```

		### Options inherited from parent commands

		```
		-t, --time Display timing information
		-v, --verbose Display debug information
		```

		### SEE ALSO

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

		###### Auto generated by spf13/cobra on 17-Jun-2019

docs/meepctl/meepctl_config_ip.md

0 → 100644

+36 −0

Original line number	Diff line number	Diff line
		## meepctl config ip

		get/get node IP address in the meepctl config file

		### Synopsis

		Get/Set node IP address in the meepctl config file

		```
		meepctl config ip [IP] [flags]
		```

		### Examples

		```
		meepctl config ip 1.2.3.4
		```

		### Options

		```
		-h, --help help for ip
		```

		### Options inherited from parent commands

		```
		-t, --time Display timing information
		-v, --verbose Display debug information
		```

		### SEE ALSO

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

		###### Auto generated by spf13/cobra on 17-Jun-2019