In addition to being able to access MetroÆ via github clone, MetroÆ is now also available for distribution via Docker container. The Docker container version of MetroÆ has all the capabilities of the github clone, plus it delivers the following:
- All MetroÆ prerequisites are satisifed by the container. Your only requirement is to run Docker.
- CLI access is provided through the
metroaecommand. - Your data is located in the file system of the host where you are running Docker. You don't need to get inside the container.
- The Container has the option of running an API/UI server, allowing you to access MetroÆ functionality via REST API and a front-end GUI.
- Docker must be installed on the system and running.
- Image files for VCS or VNS deployments must be available locally.
The metroae command is at the heart of interacting with the MetroÆ container. It is delivered from the github repo. It is used both to manage the container and to execute MetroÆ inside the container. You can access all of the command options via ./metroae <action | workflow> [deployment] [options].
The following command options are supported by the metroae command:
help -displays the help text for the command
pull - pulls the MetroÆ container from the registry. By default, the latest container is pulled. You can also specify a valid container tag to pull another version, e.g. ./metroae pull 1.0.0.
setup - setup completes the steps necessary to get the MetroÆ container up and running. It prompts you for the full paths to data and image directories that the container uses on your local disk. On Mac OS, you will also be prompted for the port that the API/UI will be listening on. By default, the API/UI listens on port 5001. You can access the API/GUI via URL, https://host_name_or_ip:5001, where host_name_or_ip is the host name or ip address of the machine on which the container is running. This host name can often be just, https://localhost:5001. Note: Running setup multiple times replaces the existing container, but it does not remove the data on your local disk.
start - starts the container using the settings from setup
stop - stops the running container
status - displays the container status along with container settings
destroy - stops and removes the metroae container along with the container image. Use this command when you want to replace an existing container with a new one, no need to run setup again afterwards.
upgrade-engine - upgrades the container to the latest available release image. You don't need to run setup again after an upgrade.
stop-ui - stops the UI server running in the container
start-ui - starts the API/UI server in the container. It prompts you for UI settings, such as whether you want to configure a certificate and whether a password will be used to encrypt passwords. The default port used by the API/UI server is 5000, as in https://localhost:5001.
status-ui - displays the status of the API/UI server in the container
unzip-files - unzips Nuage Networks tar.gz files into the images directory specified during the setup operation. Use of this command requires that the tar.gz files be placed in either the data or images directory that you specified during setup. See the current values of the data and images directories by executing the status command.
convert-build-vars-to-deployments - converts a legacy MetroÆ 2 build_vars.yml file into a MetroÆ 3 deployment. Use of this command requires that the build_vars.yml file be present in either the data or images directory that you specified during setup. You can get the current values of the data and images directories by executing the status command.
generate-example-from-schema - generates an example for the specified schema and puts it in the examples directory under the data directory that you specified during setup. You can get the current values of the data and images directories by executing the status command.
encrypt-credentials - sets the encryption credentials for encrypting secure user data, e.g. passwords
enable-ui-encryption - sets up a TLS certificate for the UI access
disable-ui-encryption - disables TLS on the UI
copy-ssh-id - copies the container's public key into the ssh authorized_keys file on the specified server. This key is required for passwordless ssh access to all target servers. Usage: metroae copy-ssh-id user@host_or_ip
--list - lists the workflows that are supported by MetroÆ
--ansible-help - shows the help options for the underlying Ansible engine
The MetroÆ container is designed so that you run MetroÆ workflows, e.g. install, from the command line using the metroae command. The format of the command line is:
`metroae <workflow> [deployment] [options]`
If MetroÆ is unable to authenticate with your target server, chances are that passwordless ssh has not been configured properly. The public key of the container must be copied to the authorized_keys file on the target server. Use the copy-ssh-id command option, e.g. ./metroae copy-ssh-id user@host_name_or_ip.
Determine the current setup by either searching for a file named .metroae in the user's home directory or by executing the status command option, e.g. ./metroae status.
metroae.log and ansible.log are located in the data directory you specified during setup.
docker pull registry.mv.nuagenetworks.net:5000/metroae:1.0
docker run -e USER_NAME='user name for the container' -e GROUP_NAME='group name for the container' -d $networkArgs -v 'path to the data mount point':/data:Z -v 'path to images mount point':/images:Z --name metroae registry.mv.nuagenetworks.net:5001/metroae:1.0
networkArgs is '--network host'
networkArgs is '-p "UI Port":5001'
docker exec 'running container id' /source/nuage-metro/metroae playbook deployment
docker stop 'running container id'
docker rm 'container id'
docker rmi 'image id'
Ask questions and get support via the forums on the MetroÆ site.
You may also contact us directly.
Outside Nokia: [email protected]
Internal Nokia: [email protected]
Report bugs you find and suggest new features and enhancements via the GitHub Issues feature.
You may also contribute to MetroÆ by submitting your own code to the project.