Skip to content

Edge Compute features

In today’s world you can easily have hundreds - if not thousands - of Docker-enabled devices in your environment. Most of these systems run without any form of clustering or run a lean orchestrator such as Docker Swarm or Kubernetes.

Remote devices may be distributed across multiple sites and/or across many different networks, some may even be attached to the internet using mobile data or satellite. To be managed effectively, engineers need a way to control distributed instances centrally, which is exactly what Portainer does with Edge Computer Features.

Enabling Edge Compute Features

First you must enable Edge Compute in the Portainer Settings.

  1. Click Settings and scroll down to Edge Compute section.

  2. Enable the toggle and 3. click Save Settings

edge

After that, you will see that a few options appear in the side menu.

edge

Edge Groups

Edge Groups allows you to create groups of Edge endpoints based on a manual selection or synamically through tags. This feature is very useful when you manage multiple Edge Endpoints in multiple zones.

To create a group, 1. go to Edge Groups and then 2. click Add Edge Group.

edge

  1. Enter a Name and then 2. select either Static or Dynamic.

Static

  1. Select the Endpoints you want to add to that group 4. These should then appear in the table on the right and finally 5. Click Add edge group

edge

Dynamic

  1. If you choose Dynamic you must choose between two options to match via Tags your Edge endpoints:

  2. Partial Match: Associate any endpoint matching at least one of the selected tags. (Each endpoint can have multiple tags).

  3. Full Match: Associate any endpoint matching all of the selected tags.

  4. Type the tag and endpoints with that tag will appear in the screen. Finally, click Add edge group

edge

Edge Stacks

This feature allows the deployment of multiple application to multiple endpoints from a single screen and multiple sources.

  1. Select Edge Stacks and then 2. Click Add stack.

edge

Next 1. Name your stack and 2. select one or more Edge Groups.

  1. In the Build Methond you need to define how to deploy your app from one of these options:

  2. Web Editor: You can use our web editor to write or paste a docker-compose file.

  3. Upload: Upload a docker-compose.yml file from your computer
  4. Repository: Use a git repository where the compose file is.
  5. Template: Use an Edge stack template.

  6. Once complete, click Deploy stack

edge

Edge Jobs

This feature is useful to define a task to run on multiple Edge endpoints, for example, backup.

Go to Edge Jobs. Then 1. Name your job and 2. Choose between the following two options:

  • Basic Configuration: Select a date from a calendar
  • Advanced Configuration: Write your own cron rule.

  • Select if this job is a recurring job and enter the job time.

You can then use the web editor to write or paste the script.

  1. Select the target endpoints
  2. To create and run the job click Create edge job

edge

Notes

Contribute to these docs.