diff --git a/docs/v2.0/settings/apps.md b/docs/v2.0/settings/apps.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/v2.0/settings/assets/edge_1.png b/docs/v2.0/settings/assets/edge_1.png new file mode 100644 index 0000000..fb79ad3 Binary files /dev/null and b/docs/v2.0/settings/assets/edge_1.png differ diff --git a/docs/v2.0/settings/assets/edge_2.png b/docs/v2.0/settings/assets/edge_2.png new file mode 100644 index 0000000..bfcff35 Binary files /dev/null and b/docs/v2.0/settings/assets/edge_2.png differ diff --git a/docs/v2.0/settings/assets/edge_3.png b/docs/v2.0/settings/assets/edge_3.png new file mode 100644 index 0000000..cb2165c Binary files /dev/null and b/docs/v2.0/settings/assets/edge_3.png differ diff --git a/docs/v2.0/settings/assets/edge_4.png b/docs/v2.0/settings/assets/edge_4.png new file mode 100644 index 0000000..0bc0f6e Binary files /dev/null and b/docs/v2.0/settings/assets/edge_4.png differ diff --git a/docs/v2.0/settings/assets/edge_5.png b/docs/v2.0/settings/assets/edge_5.png new file mode 100644 index 0000000..6e111ac Binary files /dev/null and b/docs/v2.0/settings/assets/edge_5.png differ diff --git a/docs/v2.0/settings/assets/edge_6.png b/docs/v2.0/settings/assets/edge_6.png new file mode 100644 index 0000000..4164c5b Binary files /dev/null and b/docs/v2.0/settings/assets/edge_6.png differ diff --git a/docs/v2.0/settings/assets/edge_7.png b/docs/v2.0/settings/assets/edge_7.png new file mode 100644 index 0000000..582bb57 Binary files /dev/null and b/docs/v2.0/settings/assets/edge_7.png differ diff --git a/docs/v2.0/settings/assets/edge_8.png b/docs/v2.0/settings/assets/edge_8.png new file mode 100644 index 0000000..5a7593d Binary files /dev/null and b/docs/v2.0/settings/assets/edge_8.png differ diff --git a/docs/v2.0/settings/edge.md b/docs/v2.0/settings/edge.md index e69de29..60a66d4 100644 --- a/docs/v2.0/settings/edge.md +++ b/docs/v2.0/settings/edge.md @@ -0,0 +1,86 @@ +# 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 + +To start to use this features, you need to enable from the Portainer Settings. + +Once you logged into Portainer, click in Settings and scroll down to Edge Compute section. + +Enable the toogle and click in Save Settings + +![edge](assets/edge_1.png) + +After that, you will see that a few options appears in the left column. + +![edge](assets/edge_2.png) + +Now, let's going to walktrough for that options in the following sections. + +## Edge Groups + +Edge Groups is a option that enable you to create groups of Edge endpoints based in a manual selection or in a dynamic way trough tags. This feature is very useful when you manage multiple Edge Endpoints in multiple zones. + +To create a group, go to Edge Groups and then a clic in Add Edge Group. + +![edge](assets/edge_3.png) + +Name the group and pick if you want to make a Static group type selecting Edge endpoints manually or choose Dynamic that automatically associate endpoints to that group trough determined tags. + +If you choose Static. Select the Endpoints you want to add to that group and do a click in Add edge group. + +![edge](assets/edge_4.png) + +If you choose Dynamic you can choose two options to match via Tags your Edge endpoints. + +* Partial Match: Associate any endpoint matching at least one of the selected tags. (Each endpoint can have multiple tags). +* Full Match: Associate any endpoint matching all of the selected tags. + +Type the tag and endpoints with that tag will appear in the screen. After that do a click in Add edge group + +![edge](assets/edge_5.png) + +## Edge Stacks + +This feature is very powerful because can help you to deploy multiple applications to a multiple endpoints from a single screen and multiple sources. + +To start using it. Click in Edge Stacks and then in Add stack. + +![edge](assets/edge_6.png) + +The following step is name your stack and select an or several Edge Groups. + +In the Build Methond you need to define how to deploy your app. Several options are available: + +* Web Editor: You can use our web editor to write or paste a docker-compose file. +* Upload: Upload a docker-compose.yml file from your computer +* Repository: Use a git repository where the compose file is. +* Template: Use an Edge stack template. + +Once this set, do a click in Deploy stack + +![edge](assets/edge_7.png) + +## Edge Jobs + +This feature is useful to define task to run of multiple Edge endpoints, fox example, backup. + +Go to Edge Jobs, name your job and 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 one and select the job time. + +After that you can use our web editor to write or paste your script directly or upload from your computer. + +After that selecte in what endpoints you need to run this job and clic in Create edge job + +![edge](assets/edge_8.png) + +## Notes + +Do you think that is missing something here? Contribute with this admin guide forking the repo [Portainer-Docs](https://github.com/portainer/portainer-docs) and propose changes. \ No newline at end of file