Skip to content

Latest commit

 

History

History
123 lines (86 loc) · 5.15 KB

config.md

File metadata and controls

123 lines (86 loc) · 5.15 KB
Raw

Eden Configuration

eden itself is an orchestrator. It manages several components together:

  • adam
  • eve
  • redis as a backing store for adam
  • eserver to serve up files to eve

Each of these can have their own config, and each can have multiple instances, running in their own ways.

Contexts

eden maintains a "contexts", a unique, named configuration adam, eve devices, redis, eserver and registry. With contexts, you can have multiple configurations, and select the one you want to use.

Contexts are stored in a context file, by default ~/.eden/contexts/<name>.yml. In addition, the currently active context is indicated in ~/.eden/context.yml. If you do not change the settings, eden will name the sole running context default, stored in ~/.eden/contexts/default.yml.

Modifying, Adding or Removing Contexts

You can change settings by doing one of the following:

  • editing a context file directly
  • using the command eden config edit <context>

Similarly, you can remove a context by deleting its file, or using eden config delete <context>, and you can add a new one by adding the file or using eden config add <context>.

You also can set the current context by editing ~/.eden/context.yml or running eden config set <context>, and you can list all known contexts with eden config list.

Every context you add creates the new instance of EVE with dedicated certificates according to generated context file inside ~/.eden/contexts/ directory. You can modify settings before running eden setup. Only one EVE instance can be run locally (in qemu). You need to stop it before starting another one.

Please see [Test configuring](../tests/README.md#Test configuring) section for details about tests config options with switching context.

Examples

New Context

To create a new context named new1 and set it to the current context:

eden config add new1  # creates a new context named "new1"
eden config edit new1 # edit the context "new1"
eden config set new1  # set the context "new1" as the current context
eden setup            # generate config and certificates based on context "new1"
eden start            # start everything up

Change Context Settings

./eden config add t1     # creates a new context named "t1"
./eden config set t1 --key eve.hostfwd --value '{"2223":"22"}' # sets the eve.hostfwd value
./eden config set t1 --key eve.telnet-port --value 7778 # sets the eve.telnet-port value

Apply Commands to a Context

./eden setup -v debug                 # runs setup using the current context
./eden setup --config t1 -v debug     # runs setup using the t1 context
./eden start -v debug                 # start all services and EVE with the current context
./eden eve start --config t1 -v debug # start second EVE with t1 context

Device Config

To get the current config in json format:

eden controller -m adam:// edge-node get-config

The above uses the adam mode to get the config for the edge-node, i.e. eve device.

To update the running eve os base image to another one, for example one stored in dist/amd64/current/installer/rootfs.img:

eden controller -m adam:// edge-node eveimage-update dist/amd64/current/installer/rootfs.img

The last argument is the path to the new rootfs image. It can be one of:

  • relative file path, like the example above, dist/amd64/current/installer/rootfs.img
  • absolute file path, e.g. /home/user1/eve/dist/amd64/current/installer/rootfs.img
  • file URL, e.g. file:///home/user1/eve/dist/amd64/current/installer/rootfs.img
  • http/s URL, e.g. https://some.server.com/path/to/rootfs.img
  • OCI registry, e.g. docker.io/lfedge/eve:6.7.8-kvm-amd64

Note that when providing the OCI registry option, you can select to get the image from the local, eden-launched registry with the --registry=local argument, e.g.

eden controller -m adam:// edge-node eveimage-update --registry=local oci://docker.io/lfedge/eve:6.7.8-kvm-amd64

To set config property of EVE from list you can use the following command:

eden controller -m adam:// edge-node update --config timer.config.interval=5

To set options for virtualized environment (if you plan to deploy applications to EVE with cpus/ram/disk larger than default described below) please use several options before run of eden setup:

  • eden config set default --key=eve.cpu --value=2 - to set 2 virtual CPUs for EVE (default is 4)
  • eden config set default --key=eve.ram --value=8096 - to set 8096 MB of ram for EVE (default is 4096)
  • eden config set default --key=eve.disk --value=65536 - to set 65536 MB of disk space for EVE (default is 8192)

Modifying of EVE config

You can obtain the current config of EVE with command eden controller edge-node get-config --file=<file>. It produces current configuration in json format obtained from Adam in the provided file. You can make modifications in this file (please do not forget to increment id.version field) and send it back with eden controller edge-node set-config --file=<file>. You can also omit file in commands and use stdin and stdout of them.