From f37ec0cc80bf6cff64bffe150e11f24b3c554851 Mon Sep 17 00:00:00 2001 From: Bruno Germano Date: Thu, 5 Nov 2026 15:02:16 -0300 Subject: [PATCH 1/2] docs(orchestrator): consolidate duplicate guides and write How it works - Retire the two first-steps guides (en and pt-br) that duplicated the deploy-journey guides with diverging steps, and redirect them to the install and create-service guides. Rechain older redirects that pointed at the retired URLs. - Carry the only content they had that the current guides lacked: bulk authorization, the HashId column and the 10-second delay. - Rewrite the How it works page as a concept page: agent and node, authorization, services and resources, binds, manifests, the Watcher, and logs. - Add a Requirements section to the node reference, and use one form for the agent commands. - Use HTTPS for the agent download and fix the contradictory log note. Refs: MM-16242 --- apps/docs/redirects/en/01.json | 12 +- apps/docs/redirects/pt-br/01.json | 12 +- .../explore-usage/explore-usage.mdx | 108 +++++++++++++---- .../authorize-node/authorize-node.mdx | 11 ++ .../install-orch-agent/install-orch-agent.mdx | 4 +- .../orchestrator/first-steps-edge-node.mdx | 109 ----------------- .../orchestrator/first-steps-edge-service.mdx | 25 ---- .../deploy/edge-orchestrator/edge-node.mdx | 37 +++++- .../edge-orchestrator/edge-orchestrator.mdx | 10 +- .../edge-orchestrator/edge-services.mdx | 2 +- .../avancado/explorar-uso/explorar-uso.mdx | 107 +++++++++++++---- .../autorizar-node/autorizar-node.mdx | 11 ++ .../instalar-orch-agent.mdx | 4 +- .../orchestrator/criando-edge-service.mdx | 27 ----- .../orchestrator/edge-node-first-steps.mdx | 110 ------------------ .../deploy/edge-orchestrator/edge-node.mdx | 37 +++++- .../edge-orchestrator/edge-orchestrator.mdx | 8 +- .../edge-orchestrator/edge-services.mdx | 2 +- apps/docs/src/nav/trees/guides.json | 8 -- 19 files changed, 300 insertions(+), 344 deletions(-) delete mode 100644 apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-node.mdx delete mode 100644 apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-service.mdx delete mode 100644 apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/criando-edge-service.mdx delete mode 100644 apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/edge-node-first-steps.mdx diff --git a/apps/docs/redirects/en/01.json b/apps/docs/redirects/en/01.json index 5668764939..36407eb5cc 100644 --- a/apps/docs/redirects/en/01.json +++ b/apps/docs/redirects/en/01.json @@ -395,6 +395,14 @@ "from": "https://www.azion.com/en/documentation/edge-firewall/", "moved": "https://www.azion.com/en/documentation/platform/firewall/" }, + { + "from": "https://www.azion.com/en/documentation/guides/application-development/automation/edge-node-first-steps/", + "moved": "https://www.azion.com/en/documentation/guides/application-development/automation/install-orchestrator-agent/" + }, + { + "from": "https://www.azion.com/en/documentation/guides/application-development/automation/edge-services-first-steps/", + "moved": "https://www.azion.com/en/documentation/guides/application-development/automation/create-edge-service/" + }, { "from": "https://www.azion.com/en/documentation/guides/application-development/getting-started/basic-troubleshooting/", "moved": "https://www.azion.com/en/documentation/support/basic-troubleshooting/" @@ -2477,11 +2485,11 @@ }, { "from": "https://www.azion.com/en/documentation/products/guides/edge-node-first-steps/", - "moved": "https://www.azion.com/en/documentation/guides/application-development/automation/edge-node-first-steps/" + "moved": "https://www.azion.com/en/documentation/guides/application-development/automation/install-orchestrator-agent/" }, { "from": "https://www.azion.com/en/documentation/products/guides/edge-services-first-steps/", - "moved": "https://www.azion.com/en/documentation/guides/application-development/automation/edge-services-first-steps/" + "moved": "https://www.azion.com/en/documentation/guides/application-development/automation/create-edge-service/" }, { "from": "https://www.azion.com/en/documentation/products/guides/edge-sql-vector-search/", diff --git a/apps/docs/redirects/pt-br/01.json b/apps/docs/redirects/pt-br/01.json index 7daaa60ab5..a6615aa399 100644 --- a/apps/docs/redirects/pt-br/01.json +++ b/apps/docs/redirects/pt-br/01.json @@ -439,6 +439,14 @@ "from": "https://www.azion.com/pt-br/documentacao/edge-firewall/", "moved": "https://www.azion.com/pt-br/documentacao/plataforma/firewall/" }, + { + "from": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criando-edge-service/", + "moved": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/" + }, + { + "from": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/edge-node-primeiros-passos/", + "moved": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/" + }, { "from": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/primeiros-passos/investigacao-problemas-basico/", "moved": "https://www.azion.com/pt-br/documentacao/suporte/investigacao-problemas-basico/" @@ -2989,11 +2997,11 @@ }, { "from": "https://www.azion.com/pt-br/documentacao/produtos/guias/orchestrator/criando-edge-service/", - "moved": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criando-edge-service/" + "moved": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/" }, { "from": "https://www.azion.com/pt-br/documentacao/produtos/guias/orchestrator/edge-node-primeiros-passos/", - "moved": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/edge-node-primeiros-passos/" + "moved": "https://www.azion.com/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/" }, { "from": "https://www.azion.com/pt-br/documentacao/produtos/guias/paywall-edge-function-jwt/", diff --git a/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx b/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx index 25292c1aac..2bf88177f5 100644 --- a/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx +++ b/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx @@ -1,38 +1,106 @@ --- -title: Explore Orchestrator +title: How Orchestrator works description: >- - Discover commands and features of Azion Orchestrator Agent, including - installation, logs, and terminal commands to enhance device functioning. + How the Orchestrator Agent turns a device into a managed node, how services + and their resources reach that node, and how the agent keeps them in the + state you defined. permalink: /documentation/platform/orchestrator/explore-usage/ meta_tags: >- - Azion Edge Orchireply, Edge Node Authorization, Orchestrator Agent, - Install Edge Agent, Edge Node Commands, Edge Terminal Commands, Edge Node - Logs, Edge Services Logs + Orchestrator, Orchestrator Agent, node, node authorization, services, + resources, triggers, variables, facts, manifest, Watcher, logs namespace: docs_deploy_explore_usage --- -import DocButton from '~/components/webkit/DocButton.vue'; +import FrameBox from '@aziontech/webkit/frame-box' +import ItemList from '@aziontech/webkit/item-list' +import DocItem from '@aziontech/webkit/doc-item' -**Azion Orchestrator** works based on an agent. This agent is installed on your device, making your device, from this moment on, an edge node that [must be authorized](/en/documentation/guides/application-development/automation/authorize-an-edge-node/) before starting the orchestration. +Orchestrator installs and keeps software on machines you run yourself, such as servers, routers, and small devices. You describe the software once, as a service in Azion Console. You choose the machines that run it, and an agent on each machine applies that description and repairs any drift from it. A change to the service reaches every machine it is bound to without a login on each one. -[Azion Orchestrator Agent](/en/documentation/guides/application-development/automation/install-orchestrator-agent/) presents a list of commands that can be run in the terminal and help you use its features. +The sections cover the agent and the node, authorization, services and their resources, the bind between a service and a node, how the agent applies a manifest, the Watcher, and the logs. -The list of commands includes: +--- -- Install and uninstall. -- Help with general commands. -- Status of the execution of the agent. +## The agent and the node - +A machine joins Orchestrator when you install the Orchestrator Agent on it. The agent is a single binary, `edge-orchestrator`, built for FreeBSD, Linux, and macOS on several processor architectures. Its `install` command registers the agent with the machine's service manager, when the machine has one, and asks for a [personal token](/en/documentation/guides/platform/account-and-billing/personal-tokens/). The token ties the machine to your Azion account. -You can [check logs](/en/documentation/guides/application-development/automation/watch-logs/) related to the edge nodes execution by accessing the file `/var/log/azion/edge-orchestrator.log` and edge services logs in `/var/log/azion/edge-services.log`. +Once the agent is installed and started, the machine is listed as a node of your account. On its first start, the agent can also set the node's name and the groups the node belongs to. Without a name, the node takes the machine's hostname. The OS, architectures, and privileges a node needs are listed in [Node requirements](/en/documentation/platform/orchestrator/edge-node/#requirements). -The Orchestrator Agent lets you turn any device into a managed edge node and operate it directly from the terminal, which is useful for hybrid and on-premises deployments that extend Azion's network to your own infrastructure. +The agent does the work on the node, and Azion Console holds the configuration. Azion manages the node remotely over an end-to-end encrypted channel, on local and public networks and behind NAT. -## Related resources +--- + +## Authorization + +A new node appears in the **Edge Nodes** list of Azion Console with the status `Waiting Authorization`, and it receives no service until you authorize it. The list identifies each node by the hash it used to register, in the **HashId** column. After the authorization, the node can take up to 10 seconds before services can be orchestrated on it. + +The step is a gate on purpose. Registration needs only the token, and authorization adds a person's approval before a machine receives your services and their configuration. The cost is one manual step per node, which the Console reduces by authorizing several nodes in one action. The steps are in [Authorize a node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/). + +--- + +## Services and resources + +A service is the description of one piece of software, kept in the **Edge Services** list of Azion Console. It holds resources, and each resource is a file the agent writes to an absolute path on the node. A resource has one of two types: + +- **Text**: the agent copies the content to the path as plain text. Configuration files use this type. +- **Shell Script**: the agent writes the script and runs it on the triggers you select. The agent runs the script with the interpreter in its shebang line, or with `/bin/sh` when the script has none. + +A Shell Script resource runs on one or more of three triggers. **Install** runs first, when the service reaches the node. **Reload** runs after every resource of the service is installed, and again whenever the bind between the service and the node changes, for example when a variable value changes. **Uninstall** runs when the service leaves the node. + +The content of a resource can carry two kinds of placeholders. A variable, written `{{ VARNAME }}`, takes a value you set, so the same service can listen on port 3306 on one node and on port 3307 on another. A fact, written `{{ FACT_NAME }}`, takes a value the agent reads from the node, such as its architecture, OS, number of CPUs, or memory. You cannot overwrite a fact. The full lists are in the [Services reference](/en/documentation/platform/orchestrator/edge-services/#variables). + +--- + +## Binding a service to a node + +A service runs nowhere until you bind it to a node. A bind names the service, the node, and the variable values for that node, so one service bound to many nodes runs everywhere with values that fit each machine. Only an active service can be bound. + +A service changes in one place and reaches every node bound to it. When you update a service, the change is deployed to the nodes bound to it. When you change a variable value on a bind, the Reload trigger runs on that node. When you remove the bind, the Uninstall trigger runs and the service leaves that node. The steps are in [Bind a service to a node](/en/documentation/guides/application-development/automation/bind-service-node/). -- [Install the Orchestrator Agent](/en/documentation/guides/application-development/automation/install-orchestrator-agent/) -- [Authorize an edge node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/) -- [Watch logs](/en/documentation/guides/application-development/automation/watch-logs/) +--- + +## How the agent applies a manifest + +The agent receives the configuration of its node as a manifest, which carries the resources of the services bound to the node. Each manifest has a version number, and the agent logs each version it applies. The agent applies a manifest in order, one resource at a time, and respects the dependencies between resources and the triggers they need. + +```mermaid +%%{init: {"layout": "elk", "themeVariables": {"fontSize": "13px"}, "flowchart": {"nodeSpacing": 24, "rankSpacing": 36, "padding": 8, "wrappingWidth": 150, "useMaxWidth": true}, "sequence": {"width": 120, "actorMargin": 30, "useMaxWidth": true}}}%% +flowchart TD + Console(["Azion Console: services, binds, variables"]) -->|"1 manifest for the node"| Agent["Orchestrator Agent on the node"] + Agent -->|"2 write each resource"| Files[["files at absolute paths"]] + Agent -->|"3 run Install, then Reload"| Scripts[["Shell Script resources"]] + Agent -->|"4 Watcher scans and restores"| Files + Agent -.->|"5 log versions and results"| Logs[("logs on the node")] +``` + +The diagram shows one node receiving its manifest. The solid arrows carry the configuration from Azion Console to the node, and the dotted arrow carries the record the agent keeps on the node. + +While a manifest is applied, the agent exposes two predefined variables to the scripts. `CHANGESET_ADD_PATH` names a file that lists the paths added or modified in this manifest, and `CHANGESET_RM_PATH` names a file that lists the paths removed or modified. A script can read them to act only on the files that changed. + +--- + +## The Watcher +After a manifest is applied, the agent keeps the files in the state it describes. A part of the agent called the Watcher runs a group of workers on a schedule. The workers scan every provisioned file and compare it with the last applied manifest. A file that was modified or removed is restored. + +The Watcher protects a node from drift, and that protection has a cost: Azion Console is the only place to change a provisioned file. A local edit on the node is reverted at the next scan, and you cannot turn the Watcher off. Every change, including an urgent one, goes into the service. Files the service does not provision are outside the Watcher's scope. + +--- + +## Logs on the node + +The agent writes two logs on the node. `/var/log/azion/edge-orchestrator.log` records the agent's own work: the manifest versions it applies, its communication with Azion, and each Watcher scan, with the number of files checked and the number that drifted. `/var/log/azion/edge-services.log` records what the triggers of the bound services wrote. To read them, refer to [Watch Orchestrator logs](/en/documentation/guides/application-development/automation/watch-logs/). + +--- + +## Related resources + + + Node requirements, and every command and option of the Orchestrator Agent. + Resources, variables, facts, and triggers, field by field. + The steps to turn a machine into a node. + The steps to describe a piece of software and its resources. + + diff --git a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx index 0355978cdd..48c7d9c07f 100644 --- a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx +++ b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx @@ -70,3 +70,14 @@ Check the [Azion API documentation](https://api.azion.com/) and the [OpenAPI spe + +## Authorize several edge nodes at once + +In Azion Console, you can authorize several edge nodes in one action: + +1. Access [Azion Console](/en/documentation/guides/platform/account-and-billing/how-to-access-azion-console/) > **Edge Nodes**. +2. Select the edge nodes you want to authorize. To select every edge node in the list, select the first checkbox on the left of the list header. +3. On the upper-right corner, click **Actions** and select **Authorize**. +4. Click **Confirm**. + +A confirmation message appears. After the authorization, an edge node can take up to 10 seconds before services can be orchestrated on it. diff --git a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx index b140e1276c..dbad8666e0 100644 --- a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx +++ b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx @@ -35,7 +35,7 @@ Download the Azion Edge Node option that matches your operating system: Alternatively, you can download it using the command line. In the example, the download link refers to the Linux/x86_64 agent. If you want to download another version, just change the URL for the required operating system or architecture: -`curl -O http://downloads.azion.com/linux/x86_64/edge-orchestrator` +`curl -O https://downloads.azion.com/linux/x86_64/edge-orchestrator` :::note The commands executed in the orchestrator agent must be executed with administrator privileges. It might be necessary to run the commands with `sudo`. @@ -69,7 +69,7 @@ If your operating system doesn't have a service manager (such as `systemd`), you ``` :::note -The logs to run the Orchestrator agent are stored in the installation directory, under `/var/log/azion/edge-orchestrator.log` +The Orchestrator agent writes its log to `/var/log/azion/edge-orchestrator.log`. ::: diff --git a/apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-node.mdx b/apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-node.mdx deleted file mode 100644 index 47b73fe0d3..0000000000 --- a/apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-node.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: Edge Node first steps -description: First steps to work with Azion Edge Node. -meta_tags: 'Orchestrator, Edge Computing' -namespace: documentation_guides_edge_node_first_steps -permalink: /documentation/guides/application-development/automation/edge-node-first-steps/ ---- - -## Installing - -1. Generate a personal token to run the actions: - -:::tip -To generate the personal token required to authenticate your edge nodes, follow the steps in the [Personal Token documentation](/en/documentation/guides/platform/account-and-billing/personal-tokens/). -::: - -2. Install the **Orchestrator** agent on the devices. -3. Authenticate the device after installation. - -To begin the **Edge Node** installation process, you must download the **Orchestrator** installation binary of your choice. - -Download the Azion Edge Node option that matches your platform of use: - -| Operating System | Architecture | File | -| :--------------- | :----------: | ------------------------------------------------------------ | -| FreeBSD | x86_64 | [edge-orchestrator](https://downloads.azion.com/freebsd/x86_64/edge-orchestrator) | -| FreeBSD | ARM64 | [edge-orchestrator](https://downloads.azion.com/freebsd/arm64/edge-orchestrator) | -| Linux | x86_32 | [edge-orchestrator](https://downloads.azion.com/linux/x86_32/edge-orchestrator) | -| Linux | x86_64 | [edge-orchestrator](https://downloads.azion.com/linux/x86_64/edge-orchestrator) | -| Linux | ARM32 | [edge-orchestrator](https://downloads.azion.com/linux/arm32/edge-orchestrator) | -| Linux | ARM64 | [edge-orchestrator](https://downloads.azion.com/linux/arm64/edge-orchestrator) | -| MacOS | x86_64 | [edge-orchestrator](https://downloads.azion.com/darwin/x86_64/edge-orchestrator) | - -Alternatively, you can download it using the Command line. In the example, the download link refers to the Linux/x86_64 agent. If you want to download another version, just change the URL for the required operating system or architecture: - -`curl -O http://downloads.azion.com/linux/x86_64/edge-orchestrator` - -:::note -The commands executed in the edge-orchestrator agent must be executed with root user privileges. It might be necessary to run the commands with `sudo`. -::: - -The root user is the one who has unrestricted access to all system components, whether files or processes. If you don't have these privileges, you may experience installation failures when attempting to manage some operating system requirements that demand such privileges. - -After downloading, follow the steps below to install the **Orchestrator** agent to your device: - -1. Install the **Orchestrator** agent:\ - `chmod +x edge-orchestrator`\ - `./edge-orchestrator install` -2. Enter the **Token** for the Orchestrator agent. -3. Start the **Orchestrator** agent after installing it:\ - `edge-orchestrator start`\ - **Note**: if your operating system doesn't have a service manager (such as `systemd`), you must run it in the foreground.\ - `edge-orchestrator start --foreground` - -:::note -The *logs* to run the Orchestrator agent are stored in:\ -`/var/log/azion/edge-orchestrator.log` -::: - ---- - -## Viewing your nodes - -Whenever the installation code is run for any device and it has been authenticated by the Token, the edge nodes will be listed in your Azion account. - -To view the list of edge nodes created for your account, access [Azion Console](https://console.azion.com/) > **Edge Nodes**. - -You can verify the listed items by checking the **HashId** column, as it contains the hash used to create and authenticate the edge node. - ---- - -## Authorizing - -You must authorize your edge nodes to begin orchestrating them. To authorize an edge node, follow the steps below: - -1. Access [Azion Console](https://console.azion.com/) > **Edge Nodes**. -2. Click on the **key icon** and accept the confirmation window. - -After the authorization, the **Edge Node** can take up to *10 seconds* before services can be orchestrated. - - -You can also authorize all the edge nodes you want at once. To start using this option, follow the steps below: - -1. Access [Azion Console](https://console.azion.com/) > **Edge Nodes**. -2. Select the items you want to authorize or, if you prefer, select all items by checking the first check box on the left. -3. On the top-right corner, click the **Actions** button and select **Authorize**. -4. A message to confirm your action will be shown. -5. Click the **Confirm** button to save your selection. -6. You'll see a confirmation message. - ---- - -## Services - -You can provision the services registered in your library by following these steps: - -1. Access [Azion Console](https://console.azion.com/) > **Edge Nodes**. -2. Select the **Edge Node** that you want to configure. -3. Open the **Services** tab and click the **+ Service** button. -4. Link it to the service you want and, if necessary, you can configure the variables required by the service. - -Services that are due to be orchestrated via Edge Node must be registered in **Edge Services** and marked as active. - -Once the service is provided, Edge Node can begin orchestrating it based on resource priorities. You can monitor the service installation process via logs in the Orchestrator agent. - -:::note -The service installation logs are stored in\ -`/var/log/azion/edge-services.log` -::: \ No newline at end of file diff --git a/apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-service.mdx b/apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-service.mdx deleted file mode 100644 index eb9873606b..0000000000 --- a/apps/docs/src/content/docs/en/pages/guides/orchestrator/first-steps-edge-service.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Creating an Edge Service -description: First steps to work with Azion Edge Services. -meta_tags: 'Orchestrator, Edge Computing' -namespace: documentation_guides_edge_services_first_steps -permalink: /documentation/guides/application-development/automation/edge-services-first-steps/ ---- - -To create an edge service, proceed as follows: - -1. Access [Azion Console](https://console.azion.com/) > **Edge Services**. -2. Click on the **+ Service** button. -3. Give a name for your service. -4. Define the variables, if necessary. - - The variables must be in the format `Variable = Value`. -5. Click the **Save** button. -6. Go to the **Resources** tab. -7. Click the **+ Resource** button. -8. Provide the path where the resource will be saved on the edge node. -9. Select the type of resource: **Text** or **Shell Script**. -10. In case of selecting **Shell Script**, configure the resources you need for your service, using the triggers: **Install**, **Reload**, and **Uninstall**. -11. Add the content of the resource. -12. Click the **Save** button. - -Done. Now your service can use one or more edge nodes. diff --git a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-node.mdx b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-node.mdx index 65e1c89c36..e859fe1986 100644 --- a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-node.mdx +++ b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-node.mdx @@ -22,14 +22,41 @@ It's an open software that can be run on different types of microprocessor archi ## Implementation | Scope | Guide | -| - | - | -| Edge Node | [ Edge Node first steps](/en/documentation/guides/application-development/automation/edge-node-first-steps/) | +| - | - | +| Install | [Install the Orchestrator Agent](/en/documentation/guides/application-development/automation/install-orchestrator-agent/) | +| Authorize | [Authorize a node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/) | + +To learn how the agent, the node, and services work together, refer to [How Orchestrator works](/en/documentation/platform/orchestrator/explore-usage/). + +--- + +## Requirements + +A machine can become a node when it meets these requirements. + +**Operating system and architecture.** The Orchestrator Agent is available for these platforms: + +| Operating system | Architecture | +| :--- | :--- | +| FreeBSD | x86_64, ARM64 | +| Linux | x86_32, x86_64, ARM32, ARM64 | +| macOS | x86_64 | + +The download link for each platform is in [Install the Orchestrator Agent](/en/documentation/guides/application-development/automation/install-orchestrator-agent/). + +**Privileges.** The agent commands run with root privileges, for example with `sudo`. Without them, the installation can fail when it changes parts of the operating system that require root. + +**Service manager.** With a service manager such as `systemd`, the `install` command registers the agent with it, and `start` and `stop` run through it. Without a service manager, run the agent in the foreground with `start --foreground`. + +**Personal token.** The `install` command asks for a [personal token](/en/documentation/guides/platform/account-and-billing/personal-tokens/) of your Azion account. The token ties the node to that account. + +**Network.** The agent works on local and public networks, and behind NAT. --- ## Agent commands and options -The Orchestrator agent has additional commands and options to make it easier to use. +The Orchestrator agent has additional commands and options to make it easier to use. The examples run the binary from the directory you downloaded it to, as the [installation guide](/en/documentation/guides/application-development/automation/install-orchestrator-agent/) does. | Command | Description | | :--- | :--- | @@ -37,8 +64,8 @@ The Orchestrator agent has additional commands and options to make it easier to | --help or -h | Helps with the commands that the agent can execute. | | install | Installs the agent to the client’s device, copies the binary to the installation location; adds the Orchestrator agent to the device's service manager (if any) and; sets up a personal token to authenticate the Edge Node. | | start \[--foreground\] | Initializes the Orchestrator agent through the device's service manager.
**Note**: the foreground option is used to run it in the foreground. | -| start -g or --join-group | Enrolls your Edge Node with the specified groups through the command line while starting your node for the first time. You can use these flags followed by a list of group names separated by a comma.
For example: `sudo edge-orchestrator start -g GROUP1,GROUP2,GROUP3 --foreground` | -| start \[-n OR --set-name\] | Enrolls your Edge Node for the first time under the specified node’s name. If these flags are not used, `hostname` will be the default value.
For example: `sudo edge-orchestrator start -n Edgenodename --foreground` | +| start -g or --join-group | Enrolls your Edge Node with the specified groups through the command line while starting your node for the first time. You can use these flags followed by a list of group names separated by a comma.
For example: `sudo ./edge-orchestrator start -g GROUP1,GROUP2,GROUP3 --foreground` | +| start \[-n OR --set-name\] | Enrolls your Edge Node for the first time under the specified node’s name. If these flags are not used, `hostname` will be the default value.
For example: `sudo ./edge-orchestrator start -n Edgenodename --foreground` | | status | Reports on the status of the execution of the Orchestrator agent. | | stop | Stops the Orchestrator agent through the device's service manager. | | uninstall | Uninstalls the agent from the client’s device; removes the binary from the installation location; removes the Orchestrator agent from the device's service manager (if any).
| diff --git a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx index 0514fd8d6f..4dfef76adb 100644 --- a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx +++ b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx @@ -28,8 +28,12 @@ With Orchestrator, you can: | Scope | Guide | | - | - | -| Node | [Node first steps](/en/documentation/guides/application-development/automation/edge-node-first-steps/) | -| Services| [Creating an Edge Service](/en/documentation/guides/application-development/automation/edge-services-first-steps/) | +| Node | [Install the Orchestrator Agent](/en/documentation/guides/application-development/automation/install-orchestrator-agent/) | +| Node | [Authorize a node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/) | +| Services | [Create a service](/en/documentation/guides/application-development/automation/create-edge-service/) | +| Services | [Bind a service to a node](/en/documentation/guides/application-development/automation/bind-service-node/) | + +To learn how the agent, nodes, and services work together, refer to [How Orchestrator works](/en/documentation/platform/orchestrator/explore-usage/). --- @@ -46,7 +50,7 @@ All services linked to Nodes will be orchestrated and configured from the moment The orchestration is done sequentially and respects the dependencies between resources and triggers needed for its configuration. -Learn more about the [Azion Orchestrator agent installation](/en/documentation/guides/application-development/automation/edge-node-first-steps/#installing). +Learn more about the [Azion Orchestrator agent installation](/en/documentation/guides/application-development/automation/install-orchestrator-agent/). --- diff --git a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-services.mdx b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-services.mdx index 0efe1092a0..c067d93512 100644 --- a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-services.mdx +++ b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-services.mdx @@ -18,7 +18,7 @@ You can configure the install, uninstall, and reload triggers and define the dep | Scope | Guide | | - | - | -| Edge Services| [Creating an Service](/en/documentation/guides/application-development/automation/edge-services-first-steps/) | +| Edge Services | [Create a service](/en/documentation/guides/application-development/automation/create-edge-service/) | --- diff --git a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx index 49af6a2eae..65049fa653 100644 --- a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx @@ -1,39 +1,106 @@ --- -title: Explore o uso do Orchestrator +title: Como o Orchestrator funciona description: >- - Descubra como utilizar o Azion Orchestrator Agent para orquestrar edge nodes. - Explore comandos, instalação e monitoramento de logs. + Como o Orchestrator Agent transforma um dispositivo em um node gerenciado, + como os serviços e os resources deles chegam a esse node e como o agente os + mantém no estado que você definiu. permalink: /documentacao/plataforma/orchestrator/explore-uso/ meta_tags: >- - Orchestrator, Edge node, autorizar edge node, instalar orchestrator - agent, comandos edge, orquestração de edge, logs edge, Azion Orchestrator - Agent + Orchestrator, Orchestrator Agent, node, autorização de node, serviços, + resources, triggers, variáveis, facts, manifesto, Watcher, logs namespace: docs_deploy_explore_usage --- -import DocButton from '~/components/webkit/DocButton.vue'; +import FrameBox from '@aziontech/webkit/frame-box' +import ItemList from '@aziontech/webkit/item-list' +import DocItem from '@aziontech/webkit/doc-item' -O [Orchestrator](/pt-br/documentacao/plataforma/orchestrator/) funciona baseado em um agente. Este agente é instalado no seu dispositivo, tornando o seu dispositivo, a partir deste momento, um edge node que [deve ser autorizado](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/) antes de iniciar a orquestração. +O Orchestrator instala e mantém software em máquinas que você mesmo opera, como servidores, roteadores e dispositivos pequenos. Você descreve o software uma vez, como um serviço no Azion Console. Você escolhe as máquinas que o executam, e um agente em cada máquina aplica essa descrição e corrige qualquer desvio dela. Uma mudança no serviço chega a todas as máquinas vinculadas a ele, sem um login em cada uma. -O [Azion Orchestrator Agent](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/) apresenta uma lista de comandos que podem ser executados no terminal e ajudam você a usar seus recursos. +As seções cobrem o agente e o node, a autorização, os serviços e os resources deles, o vínculo entre um serviço e um node, como o agente aplica um manifesto, o Watcher e os logs. -A lista de comandos inclui: +--- -- Instalação e desinstalação. -- Ajuda com comandos gerais. -- Status da execução do agente. +## O agente e o node - +Uma máquina entra no Orchestrator quando você instala o Orchestrator Agent nela. O agente é um único binário, `edge-orchestrator`, disponível para FreeBSD, Linux e macOS em várias arquiteturas de processador. O comando `install` registra o agente no gerenciador de serviços da máquina, quando ela tem um, e pede um [personal token](/pt-br/documentacao/guias/plataforma/conta-e-billing/personal-tokens/). O token vincula a máquina à sua conta Azion. -Você pode [verificar os logs](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/verificar-logs/) relacionados à execução dos edge nodes acessando o arquivo `/var/log/azion/edge-orchestrator.log` e aos edge services em `/var/log/azion/edge-services.log`. +Depois que o agente é instalado e iniciado, a máquina aparece como um node da sua conta. Na primeira inicialização, o agente também pode definir o nome do node e os grupos aos quais ele pertence. Sem um nome, o node recebe o hostname da máquina. O sistema operacional, as arquiteturas e os privilégios que um node precisa estão em [Requisitos do node](/pt-br/documentacao/plataforma/orchestrator/edge-node/#requisitos). -O Orchestrator Agent permite transformar qualquer dispositivo em um edge node gerenciado e operá-lo diretamente pelo terminal, o que é útil para implantações híbridas e on-premises que estendem a rede da Azion à sua própria infraestrutura. +O agente faz o trabalho no node, e o Azion Console guarda a configuração. A Azion gerencia o node remotamente por um canal com criptografia de ponta a ponta, em redes locais e públicas e atrás de NAT. -## Recursos relacionados +--- + +## Autorização + +Um node novo aparece na lista **Edge Nodes** do Azion Console com o status `Waiting Authorization` e não recebe nenhum serviço até que você o autorize. A lista identifica cada node pelo hash que ele usou para se registrar, na coluna **HashId**. Depois da autorização, o node pode levar até 10 segundos para que serviços possam ser orquestrados nele. + +Essa etapa é um bloqueio intencional. O registro precisa apenas do token, e a autorização adiciona a aprovação de uma pessoa antes que uma máquina receba seus serviços e a configuração deles. O custo é uma etapa manual por node, que o Console reduz ao autorizar vários nodes em uma única ação. Os passos estão em [Autorizar um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/). + +--- + +## Serviços e resources -- [Instalar o Orchestrator Agent](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/) -- [Autorizar um edge node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/) -- [Verificar os logs](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/verificar-logs/) +Um serviço é a descrição de um software, guardada na lista **Edge Services** do Azion Console. Ele contém resources, e cada resource é um arquivo que o agente grava em um caminho absoluto no node. Um resource tem um de dois tipos: + +- **Text**: o agente copia o conteúdo para o caminho como texto simples. Arquivos de configuração usam esse tipo. +- **Shell Script**: o agente grava o script e o executa nos triggers que você seleciona. O agente executa o script com o interpretador da linha shebang, ou com `/bin/sh` quando o script não tem uma. + +Um resource Shell Script roda em um ou mais de três triggers. **Install** roda primeiro, quando o serviço chega ao node. **Reload** roda depois que todos os resources do serviço são instalados, e de novo sempre que o vínculo entre o serviço e o node muda, por exemplo quando o valor de uma variável muda. **Uninstall** roda quando o serviço sai do node. + +O conteúdo de um resource pode ter dois tipos de marcadores. Uma variável, escrita `{{ VARNAME }}`, recebe um valor que você define, então o mesmo serviço pode escutar na porta 3306 em um node e na porta 3307 em outro. Um fact, escrito `{{ FACT_NAME }}`, recebe um valor que o agente lê do node, como a arquitetura, o sistema operacional, o número de CPUs ou a memória. Não é possível sobrescrever um fact. As listas completas estão na [referência de Services](/pt-br/documentacao/plataforma/orchestrator/edge-services/#variables). --- +## Vincular um serviço a um node + +Um serviço não roda em lugar nenhum até que você o vincule a um node. Um vínculo nomeia o serviço, o node e os valores das variáveis para esse node. Assim, um serviço vinculado a vários nodes roda em todos eles com valores adequados a cada máquina. Apenas um serviço ativo pode ser vinculado. + +Um serviço muda em um só lugar e chega a todos os nodes vinculados a ele. Quando você atualiza um serviço, a mudança é implantada nos nodes vinculados. Quando você muda o valor de uma variável em um vínculo, o trigger Reload roda naquele node. Quando você remove o vínculo, o trigger Uninstall roda e o serviço sai daquele node. Os passos estão em [Vincular um serviço a um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/vincular-servico/). + +--- + +## Como o agente aplica um manifesto + +O agente recebe a configuração do node dele como um manifesto, que carrega os resources dos serviços vinculados ao node. Cada manifesto tem um número de versão, e o agente registra em log cada versão que aplica. O agente aplica um manifesto em ordem, um resource por vez, e respeita as dependências entre os resources e os triggers de que eles precisam. + +```mermaid +%%{init: {"layout": "elk", "themeVariables": {"fontSize": "13px"}, "flowchart": {"nodeSpacing": 24, "rankSpacing": 36, "padding": 8, "wrappingWidth": 150, "useMaxWidth": true}, "sequence": {"width": 120, "actorMargin": 30, "useMaxWidth": true}}}%% +flowchart TD + Console(["Azion Console: serviços, vínculos, variáveis"]) -->|"1 manifesto do node"| Agent["Orchestrator Agent no node"] + Agent -->|"2 grava cada resource"| Files[["arquivos em caminhos absolutos"]] + Agent -->|"3 roda Install, depois Reload"| Scripts[["resources Shell Script"]] + Agent -->|"4 Watcher verifica e restaura"| Files + Agent -.->|"5 registra versões e resultados"| Logs[("logs no node")] +``` + +O diagrama mostra um node recebendo o manifesto dele. As setas contínuas levam a configuração do Azion Console até o node, e a seta pontilhada leva o registro que o agente mantém no node. + +Enquanto um manifesto é aplicado, o agente expõe duas variáveis predefinidas para os scripts. `CHANGESET_ADD_PATH` aponta para um arquivo com a lista de caminhos adicionados ou modificados neste manifesto, e `CHANGESET_RM_PATH` aponta para um arquivo com a lista de caminhos removidos ou modificados. Um script pode lê-las para agir apenas sobre os arquivos que mudaram. + +--- + +## O Watcher + +Depois que um manifesto é aplicado, o agente mantém os arquivos no estado que ele descreve. Uma parte do agente chamada Watcher executa um grupo de workers periodicamente. Os workers verificam cada arquivo provisionado e o comparam com o último manifesto aplicado. Um arquivo que foi modificado ou removido é restaurado. + +O Watcher protege o node contra desvios, e essa proteção tem um custo: o Azion Console é o único lugar para mudar um arquivo provisionado. Uma edição local no node é revertida na próxima verificação, e não é possível desativar o Watcher. Toda mudança, inclusive uma urgente, entra no serviço. Arquivos que o serviço não provisiona ficam fora do escopo do Watcher. + +--- + +## Logs no node + +O agente grava dois logs no node. `/var/log/azion/edge-orchestrator.log` registra o trabalho do próprio agente: as versões de manifesto que ele aplica, a comunicação dele com a Azion e cada verificação do Watcher, com o número de arquivos verificados e o número dos que tiveram desvio. `/var/log/azion/edge-services.log` registra o que os triggers dos serviços vinculados escreveram. Para lê-los, consulte [Verificar os logs do Orchestrator](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/verificar-logs/). + +--- + +## Recursos relacionados + + + + Os requisitos do node e todos os comandos e opções do Orchestrator Agent. + Resources, variáveis, facts e triggers, campo a campo. + Os passos para transformar uma máquina em um node. + Os passos para descrever um software e os resources dele. + + diff --git a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx index 78264464e7..de3d6cb513 100644 --- a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx @@ -70,3 +70,14 @@ Confira a [documentação da API Azion](https://api.azion.com/) e a [especifica + +## Autorize vários edge nodes de uma vez + +No Azion Console, você pode autorizar vários edge nodes em uma única ação: + +1. Acesse o [Azion Console](/pt-br/documentacao/guias/plataforma/conta-e-billing/como-acessar-o-azion-console/) > **Edge Nodes**. +2. Selecione os edge nodes que você quer autorizar. Para selecionar todos os edge nodes da lista, marque a primeira caixa de seleção à esquerda do cabeçalho da lista. +3. No canto superior direito, clique em **Actions** e selecione **Authorize**. +4. Clique em **Confirm**. + +Uma mensagem de confirmação aparece. Depois da autorização, um edge node pode levar até 10 segundos para que serviços possam ser orquestrados nele. diff --git a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx index 3400fa1696..1ef4c62ecb 100644 --- a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx @@ -36,7 +36,7 @@ Baixe a opção que corresponde ao seu sistema operacional: Alternativamente, você pode baixá-lo usando a linha de comando. No exemplo, o link de download se refere ao agente para `Linux/x86_64`. Se você quiser baixar outra versão, basta alterar a URL para o sistema operacional ou arquitetura necessários: -`curl -O http://downloads.azion.com/linux/x86_64/edge-orchestrator` +`curl -O https://downloads.azion.com/linux/x86_64/edge-orchestrator` :::note Os comandos executados no Orchestrator Agent devem ser executados com privilégios de administrador. Pode ser necessário executar os comandos com `sudo`. @@ -70,7 +70,7 @@ sudo ./edge-orchestrator start --foreground ``` :::note -Os logs para executar o Orchestrator Agent são armazenados no diretório de instalação, em `/var/log/azion/edge-orchestrator.log` +O Orchestrator Agent grava o log dele em `/var/log/azion/edge-orchestrator.log`. ::: diff --git a/apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/criando-edge-service.mdx b/apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/criando-edge-service.mdx deleted file mode 100644 index 4a5300525c..0000000000 --- a/apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/criando-edge-service.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Criando um edge service -description: Crie um edge service para ser usado em seus edge nodes. -meta_tags: 'Orchestrator, Edge Computing' -namespace: documentation_guides_edge_services_first_steps -permalink: /documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criando-edge-service/ ---- - -Para criar um edge service, siga o passo-a-passo a seguir: - -1. Acesse [Azion Console](https://console.azion.com/) > **Edge Services**. -2. Clique no botão **+ Service**. -3. Nomeie seu serviço. -4. Defina as variáveis a usar, se necessário. - - As variáveis devem seguir o padrão "Variável = Valor". -5. Clique no botão **Save**. -6. Selecione a aba **Resources**. -7. Clique no botão **+ Resource**. -8. Forneça o caminho onde o recurso será salvo no edge node. -9. Selecione o tipo de recurso: **Text** ou **Shell Script**. -10. No caso de selecionar **Shell Script**, configure os recursos que você precisa para o seu serviço, usando os gatilhos: **Install**, **Reload**, and **Uninstall**. -11. Adicione o conteúdo do recurso. -12. Clique no botão **Save**. - -Pronto. Agora seu serviço pode ser utilizado em um ou mais edge nodes. - ---- diff --git a/apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/edge-node-first-steps.mdx b/apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/edge-node-first-steps.mdx deleted file mode 100644 index ca0eba9e2b..0000000000 --- a/apps/docs/src/content/docs/pt-br/pages/guias/orchestrator/edge-node-first-steps.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: Primeiros passos no Edge Node -description: Primeiros passos para trabalhar com o Azion Edge Node. -meta_tags: 'Orchestrator, Edge Computing' -namespace: documentation_guides_edge_node_first_steps -permalink: /documentacao/guias/desenvolvimento-de-aplicacoes/automacao/edge-node-primeiros-passos/ ---- - -## Instalação - -1. Gere um personal token para executar as ações. - -:::tip -Para gerar o personal token necessário para autenticar seus edge nodes, siga os passos da [documentação de Personal Token](/pt-br/documentacao/guias/plataforma/conta-e-billing/personal-tokens/). -::: - -2. Instale o agente **Orchestrator** nos seus dispositivos. -3. Autentique o dispositivo depois da instalação. - -Para iniciar o processo de instalação do **Edge Node**, você deve fazer o download do binário de instalação do **Orchestrator** de sua preferência. - -Confira a listagem de plataformas compatíveis com o Azion Edge Node e faça o download: - -| Sistema Operacional | Arquitetura | Arquivo | -| :--- | :---: | --- | -| FreeBSD | x86_64 | [edge-orchestrator](https://downloads.azion.com/freebsd/x86_64/edge-orchestrator) | -| FreeBSD | ARM64 | [edge-orchestrator](https://downloads.azion.com/freebsd/arm64/edge-orchestrator) | -| Linux | x86_32 | [edge-orchestrator](https://downloads.azion.com/linux/x86_32/edge-orchestrator) | -| Linux | x86_64 | [edge-orchestrator](https://downloads.azion.com/linux/x86_64/edge-orchestrator) | -| Linux | ARM32 | [edge-orchestrator](https://downloads.azion.com/linux/arm32/edge-orchestrator) | -| Linux | ARM64 | [edge-orchestrator](https://downloads.azion.com/linux/arm64/edge-orchestrator) | -| MacOS | x86_64 | [edge-orchestrator](https://downloads.azion.com/darwin/x86_64/edge-orchestrator) | - -Como alternativa, você pode fazer download via linha de comando. No exemplo, o link para download é referente ao agente Linux/x86_64. Caso queira fazer o download de outra versão, basta alterar a URL para o sistema operacional ou a arquitetura desejada: - -`curl -O http://downloads.azion.com/linux/x86_64/edge-orchestrator` - -:::note -Os comandos executados no agente *edge-orchestrator* devem ser executados com *privilégios de usuário root*. -::: - -O usuário root é aquele que tem acesso irrestrito a todos os componentes do sistema, tanto arquivos quanto processos. Caso você não tenha esses privilégios, pode haver falha na instalação ao tentar gerenciar alguns requisitos do sistema operacional que exigem esses privilégios. - -Após o download, você deve seguir os passos abaixo, para que seu dispositivo instale o agente do **Orchestrator**: - -1. Instale o agente do **Orchestrator**:\ - `chmod +x edge-orchestrator`\ - `./edge-orchestrator install` -2. Informe o **token** para o agente do Orchestrator. -3. Confirme as etapas seguintes. -4. Inicialize o agente do **Orchestrator** após finalizar a instalação:\ - `edge-orchestrator start`\ - **Observação**: caso o seu sistema operacional não disponha de um gerenciador de serviços (systemd, por exemplo), você deve executar como foreground:\ -`edge-orchestrator start --foreground` - -:::note -Os _logs_ de execução do agente do Orchestrator são armazenados em\ -`/var/log/azion/edge-orchestrator.log` -::: - ---- - -## Visualização de seus nodes - -Sempre que o código de instalação for executado em algum dispositivo, seguido da autenticação via token, os edge nodes serão listados na sua conta da Azion. - -Para visualizar a lista de edge nodes criados para a sua conta, acesse [Azion Console](https://console.azion.com/) > **Edge Nodes**. - -Os itens listados podem ser verificados validando a coluna de HashId, pois ela contém o hash utilizado para a criação e autenticação do edge node. - ---- - -## Autorização - -Para começar a orquestração dos seus edge nodes, eles devem ser autorizados. Para autorizá-los, os seguintes passos devem ser executados: - -1. Acesse [Azion Console](https://console.azion.com/) > **Edge Nodes**. -2. Clique no ícone em formato de chave e aceite a janela de confirmação. - -Após a autorização, o Edge Node pode demorar até *10 segundos* para que a orquestração dos serviços seja iniciada. - -Você também pode autorizar todos os seus edge nodes que desejar de uma única vez. Para fazer uso dessa opção, siga os passos abaixo: - -1. Acesse [Azion Console](https://console.azion.com/) > **Edge Nodes**. -2. Selecione os itens que você quer autorizar ou, se preferir, selecione todos os ícones clicando na primeira caixa de seleção à esquerda. -3. No canto superior direito, clique no botão **Actions** e selecione **Authorize**. -4. Uma mensagem confirmando a sua ação será mostrada. -5. Clique no botão **Confirm** para salvar sua seleção. -6. Você verá uma mensagem de confirmação. - ---- - -## Serviços - -Para provisionar os serviços cadastrados na sua biblioteca, siga os passos abaixo: - -1. Acesse [Azion Console](https://console.azion.com/) > **Edge Nodes**. -2. Selecione o edge node que deseja configurar. -3. Acesse a aba **Services** e clicar no botão **+ Service**. -4. Vincule o serviço desejado e, caso necessário, configure as variáveis necessárias para a sua execução. - - -Os serviços disponíveis para orquestração via Edge Node devem estar cadastrados em **Edge Services** e marcados como ativos. - -Após a provisão do serviço, o Edge Node inicia a orquestração seguindo a prioridade dos recursos. Você pode acompanhar o processo de instalação dos serviços via logs no agente do Orchestrator. - -:::note -Os logs de instalação do serviço são armazenados em\ -`/var/log/azion/edge-services.log` -::: diff --git a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-node.mdx b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-node.mdx index 6b5085d496..36120f918e 100644 --- a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-node.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-node.mdx @@ -17,14 +17,41 @@ O Azion **Edge Node** permite que você crie a sua própria estrutura Edge e hab ## Implementação | Escopo | Guia | -| - | - | -| Edge Node | [Edge Node primeiros passos](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/edge-node-primeiros-passos/) | +| - | - | +| Instalar | [Instalar o Orchestrator Agent](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/) | +| Autorizar | [Autorizar um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/) | + +Para entender como o agente, o node e os serviços funcionam juntos, consulte [Como o Orchestrator funciona](/pt-br/documentacao/plataforma/orchestrator/explore-uso/). + +--- + +## Requisitos + +Uma máquina pode se tornar um node quando atende a estes requisitos. + +**Sistema operacional e arquitetura.** O Orchestrator Agent está disponível para estas plataformas: + +| Sistema operacional | Arquitetura | +| :--- | :--- | +| FreeBSD | x86_64, ARM64 | +| Linux | x86_32, x86_64, ARM32, ARM64 | +| macOS | x86_64 | + +O link de download de cada plataforma está em [Instalar o Orchestrator Agent](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/). + +**Privilégios.** Os comandos do agente rodam com privilégios de root, por exemplo com `sudo`. Sem eles, a instalação pode falhar quando altera partes do sistema operacional que exigem root. + +**Gerenciador de serviços.** Com um gerenciador de serviços como o `systemd`, o comando `install` registra o agente nele, e `start` e `stop` rodam por meio dele. Sem um gerenciador de serviços, rode o agente em primeiro plano com `start --foreground`. + +**Personal token.** O comando `install` pede um [personal token](/pt-br/documentacao/guias/plataforma/conta-e-billing/personal-tokens/) da sua conta Azion. O token vincula o node a essa conta. + +**Rede.** O agente funciona em redes locais e públicas, e atrás de NAT. --- ## Comandos e opções do agente -O agente do Orchestrator apresenta alguns comandos e opções para facilitar o seu uso. +O agente do Orchestrator apresenta alguns comandos e opções para facilitar o seu uso. Os exemplos rodam o binário a partir do diretório onde ele foi baixado, como faz o [guia de instalação](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/). | | Descrição | | :--- | :--- | @@ -32,8 +59,8 @@ O agente do Orchestrator apresenta alguns comandos e opções para facilitar o s | --help ou -h | Ajuda sobre os comandos que podem ser executados no agente. | | install | Instala o agente no device do cliente; copia o binário para o local de instalação; adiciona o agente do Orchestrator ao gerenciador de serviços do device (caso exista); e configura as credenciais para autenticação do Edge Node. | | start \[--foreground\] | Inicializa o agente do Orchestrator por meio do gerenciador de serviços do device.
Observação: a opção foreground é utilizada para execução em primeiro plano. | -| start \[-g OR --join-group\] | Ao utilizar estas flags seguidas por uma lista de nomes de grupos separada por vírgulas, você pode registrar seu edge-node com o(s) grupo(s) especificado(s) através da linha de comando ao iniciá-lo pela primeira vez.
Exemplo: sudo edge-orchestrator start -g GROUP1,GROUP2,GROUP3 --foreground | -| start \[-n OR --set-name\] | Ao utilizar estas flags seguidas do nome desejado, você pode especificar o nome de seu novo node através da linha de comando ao iniciá-lo pela primeira vez . Caso não sejam usadas, o hostname é usado como valor padrão.
Exemplo: sudo edge-orchestrator start -n Edgenodename --foreground | +| start \[-g OR --join-group\] | Ao utilizar estas flags seguidas por uma lista de nomes de grupos separada por vírgulas, você pode registrar seu edge-node com o(s) grupo(s) especificado(s) através da linha de comando ao iniciá-lo pela primeira vez.
Exemplo: `sudo ./edge-orchestrator start -g GROUP1,GROUP2,GROUP3 --foreground` | +| start \[-n OR --set-name\] | Ao utilizar estas flags seguidas do nome desejado, você pode especificar o nome de seu novo node através da linha de comando ao iniciá-lo pela primeira vez . Caso não sejam usadas, o hostname é usado como valor padrão.
Exemplo: `sudo ./edge-orchestrator start -n Edgenodename --foreground` | | status | Obtém o status de execução do agente do Orchestrator. | | stop | Para a execução do agente do Orchestrator por meio do gerenciador de serviços do device. | | uninstall | Desinstala o agente do device do cliente. Remove o binário do local de instalação; remove o agente do Orchestrator do gerenciador de serviços do device (caso exista).
Observação: as credenciais de autenticação permanecem no device e podem ser removidas via painel de controle da Azion. | diff --git a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx index 0636e2b5fc..cf958281cf 100644 --- a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx @@ -24,8 +24,12 @@ Com o Orchestrator, você pode: | Escopo | Guia | | - | - | -| Edge Node | [Edge Node primeiros passos](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/edge-node-primeiros-passos/) | -| Edge Services | [Criando um Edge service](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criando-edge-service/) | +| Node | [Instalar o Orchestrator Agent](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/) | +| Node | [Autorizar um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/) | +| Services | [Criar um serviço](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/) | +| Services | [Vincular um serviço a um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/vincular-servico/) | + +Para entender como o agente, os nodes e os serviços funcionam juntos, consulte [Como o Orchestrator funciona](/pt-br/documentacao/plataforma/orchestrator/explore-uso/). --- diff --git a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-services.mdx b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-services.mdx index c7ee66492c..f4df8941be 100644 --- a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-services.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-services.mdx @@ -22,7 +22,7 @@ Configure os gatilhos de instalação, desinstalação e recarregamento e defina | Escopo | Guia | | - | - | -| Edge Services| [Criando um edge service](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criando-edge-service/) | +| Edge Services | [Criar um serviço](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/) | --- diff --git a/apps/docs/src/nav/trees/guides.json b/apps/docs/src/nav/trees/guides.json index a43f1a3ddb..d42fe55119 100644 --- a/apps/docs/src/nav/trees/guides.json +++ b/apps/docs/src/nav/trees/guides.json @@ -925,14 +925,6 @@ "page": "documentation_hub_guides_build_and_run_applications_automation", "landing": true, "items": [ - { - "page": "documentation_guides_edge_services_first_steps", - "products": ["orchestrator"] - }, - { - "page": "documentation_guides_edge_node_first_steps", - "products": ["orchestrator"] - }, { "page": "docs_deploy_authorize_node", "products": ["orchestrator"] From 1016041e3ab09a5b05cc67384438d2ac4eaec2d5 Mon Sep 17 00:00:00 2001 From: Marcus Souza Date: Thu, 12 Nov 2026 15:25:59 -0300 Subject: [PATCH 2/2] docs(orchestrator): fix sourcing, diagram, and click paths in the consolidated pages - How it works: drop the unsourced authorization rationale, scope the Watcher sentence to the service and its binds, rebuild the manifest diagram with a legend and numbered steps, link variables and facts separately, rename the gerund heading, and trim the descriptions. - Authorize node: state the 10-second delay for every authorization, and use the canonical click path and select verbs in the bulk section. - Install guide: add the outcome (Edge Nodes list, Waiting Authorization, HashId) that the retired first-steps guide carried. - Overview: replace "Learn more" phrasing; translate the pt-br scope cells. --- .../explore-usage/explore-usage.mdx | 36 ++++++++++++------- .../authorize-node/authorize-node.mdx | 14 ++++---- .../install-orch-agent/install-orch-agent.mdx | 2 ++ .../edge-orchestrator/edge-orchestrator.mdx | 2 +- .../avancado/explorar-uso/explorar-uso.mdx | 36 ++++++++++++------- .../autorizar-node/autorizar-node.mdx | 14 ++++---- .../instalar-orch-agent.mdx | 4 ++- .../edge-orchestrator/edge-orchestrator.mdx | 4 +-- 8 files changed, 70 insertions(+), 42 deletions(-) diff --git a/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx b/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx index 2bf88177f5..cf3d447c55 100644 --- a/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx +++ b/apps/docs/src/content/docs/en/pages/deploy-journey/advanced-config/explore-usage/explore-usage.mdx @@ -1,9 +1,8 @@ --- title: How Orchestrator works description: >- - How the Orchestrator Agent turns a device into a managed node, how services - and their resources reach that node, and how the agent keeps them in the - state you defined. + How the Orchestrator Agent turns a machine into a managed node, how services + reach it, and how the agent keeps their files in the state you defined. permalink: /documentation/platform/orchestrator/explore-usage/ meta_tags: >- Orchestrator, Orchestrator Agent, node, node authorization, services, @@ -35,7 +34,7 @@ The agent does the work on the node, and Azion Console holds the configuration. A new node appears in the **Edge Nodes** list of Azion Console with the status `Waiting Authorization`, and it receives no service until you authorize it. The list identifies each node by the hash it used to register, in the **HashId** column. After the authorization, the node can take up to 10 seconds before services can be orchestrated on it. -The step is a gate on purpose. Registration needs only the token, and authorization adds a person's approval before a machine receives your services and their configuration. The cost is one manual step per node, which the Console reduces by authorizing several nodes in one action. The steps are in [Authorize a node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/). +In Azion Console, you can authorize several nodes in one action. The steps are in [Authorize a node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/). --- @@ -48,11 +47,11 @@ A service is the description of one piece of software, kept in the **Edge Servic A Shell Script resource runs on one or more of three triggers. **Install** runs first, when the service reaches the node. **Reload** runs after every resource of the service is installed, and again whenever the bind between the service and the node changes, for example when a variable value changes. **Uninstall** runs when the service leaves the node. -The content of a resource can carry two kinds of placeholders. A variable, written `{{ VARNAME }}`, takes a value you set, so the same service can listen on port 3306 on one node and on port 3307 on another. A fact, written `{{ FACT_NAME }}`, takes a value the agent reads from the node, such as its architecture, OS, number of CPUs, or memory. You cannot overwrite a fact. The full lists are in the [Services reference](/en/documentation/platform/orchestrator/edge-services/#variables). +The content of a resource can carry two kinds of placeholders. A variable, written `{{ VARNAME }}`, takes a value you set, so the same service can listen on port 3306 on one node and on port 3307 on another. A fact, written `{{ FACT_NAME }}`, takes a value the agent reads from the node, such as its architecture, OS, number of CPUs, or memory. You cannot overwrite a fact. The Services reference lists the [predefined variables](/en/documentation/platform/orchestrator/edge-services/#variables) and the [facts](/en/documentation/platform/orchestrator/edge-services/#facts). --- -## Binding a service to a node +## The bind between a service and a node A service runs nowhere until you bind it to a node. A bind names the service, the node, and the variable values for that node, so one service bound to many nodes runs everywhere with values that fit each machine. Only an active service can be bound. @@ -64,17 +63,28 @@ A service changes in one place and reaches every node bound to it. When you upda The agent receives the configuration of its node as a manifest, which carries the resources of the services bound to the node. Each manifest has a version number, and the agent logs each version it applies. The agent applies a manifest in order, one resource at a time, and respects the dependencies between resources and the triggers they need. +The diagram shows one node receiving its manifest. Solid arrows carry the configuration and the actions the agent takes on the node, and the thick arrow carries the log the agent writes. Each label starts with the number of its step below. + ```mermaid %%{init: {"layout": "elk", "themeVariables": {"fontSize": "13px"}, "flowchart": {"nodeSpacing": 24, "rankSpacing": 36, "padding": 8, "wrappingWidth": 150, "useMaxWidth": true}, "sequence": {"width": 120, "actorMargin": 30, "useMaxWidth": true}}}%% flowchart TD - Console(["Azion Console: services, binds, variables"]) -->|"1 manifest for the node"| Agent["Orchestrator Agent on the node"] - Agent -->|"2 write each resource"| Files[["files at absolute paths"]] - Agent -->|"3 run Install, then Reload"| Scripts[["Shell Script resources"]] - Agent -->|"4 Watcher scans and restores"| Files - Agent -.->|"5 log versions and results"| Logs[("logs on the node")] + Console["Azion Console"] + Agent["Orchestrator Agent"] + Files[["provisioned files"]] + Scripts[["Shell Script resources"]] + Logs[("logs on the node")] + Console -->|"1. manifest"| Agent + Agent -->|"2. write"| Files + Agent -->|"3. Install, Reload"| Scripts + Agent -->|"4. restore drift"| Files + Agent ==>|"5. log"| Logs ``` -The diagram shows one node receiving its manifest. The solid arrows carry the configuration from Azion Console to the node, and the dotted arrow carries the record the agent keeps on the node. +1. The node receives a manifest with the resources of the services bound to it and the variable values of each bind. +2. The agent writes each resource to its absolute path, one resource at a time. +3. The agent runs the Install trigger of each Shell Script resource, then Reload. +4. The Watcher scans the provisioned files on a schedule and restores any file that drifted from the last applied manifest. +5. The agent logs the manifest version it applied and the result of each Watcher scan. While a manifest is applied, the agent exposes two predefined variables to the scripts. `CHANGESET_ADD_PATH` names a file that lists the paths added or modified in this manifest, and `CHANGESET_RM_PATH` names a file that lists the paths removed or modified. A script can read them to act only on the files that changed. @@ -84,7 +94,7 @@ While a manifest is applied, the agent exposes two predefined variables to the s After a manifest is applied, the agent keeps the files in the state it describes. A part of the agent called the Watcher runs a group of workers on a schedule. The workers scan every provisioned file and compare it with the last applied manifest. A file that was modified or removed is restored. -The Watcher protects a node from drift, and that protection has a cost: Azion Console is the only place to change a provisioned file. A local edit on the node is reverted at the next scan, and you cannot turn the Watcher off. Every change, including an urgent one, goes into the service. Files the service does not provision are outside the Watcher's scope. +The Watcher protects a node from drift, and that protection has a cost: the service and its binds are the only places to change a provisioned file. A local edit on the node is reverted at the next scan, and you cannot turn the Watcher off. Every change, including an urgent one, goes into the service. Files the service does not provision are outside the Watcher's scope. --- diff --git a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx index 48c7d9c07f..77357d4b37 100644 --- a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx +++ b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/authorize-node/authorize-node.mdx @@ -71,13 +71,15 @@ Check the [Azion API documentation](https://api.azion.com/) and the [OpenAPI spe +After the authorization, an edge node can take up to 10 seconds before services can be orchestrated on it. + ## Authorize several edge nodes at once -In Azion Console, you can authorize several edge nodes in one action: +To authorize several edge nodes in one action in Azion Console: -1. Access [Azion Console](/en/documentation/guides/platform/account-and-billing/how-to-access-azion-console/) > **Edge Nodes**. -2. Select the edge nodes you want to authorize. To select every edge node in the list, select the first checkbox on the left of the list header. -3. On the upper-right corner, click **Actions** and select **Authorize**. -4. Click **Confirm**. +1. Access [Azion Console](https://console.azion.com/) > **Edge Nodes**. +2. Select the edge nodes you want to authorize. To select every edge node in the list, select the checkbox in the list header. +3. Select **Actions** and then select **Authorize**. +4. Select **Confirm**. -A confirmation message appears. After the authorization, an edge node can take up to 10 seconds before services can be orchestrated on it. +A confirmation message appears. diff --git a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx index dbad8666e0..0d2182a95b 100644 --- a/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx +++ b/apps/docs/src/content/docs/en/pages/deploy-journey/configure-node/install-orch-agent/install-orch-agent.mdx @@ -72,4 +72,6 @@ If your operating system doesn't have a service manager (such as `systemd`), you The Orchestrator agent writes its log to `/var/log/azion/edge-orchestrator.log`. ::: +The machine now appears in the **Edge Nodes** list of [Azion Console](https://console.azion.com/) as an edge node with the status `Waiting Authorization`. The **HashId** column shows the hash the edge node used to register. Before services can run on it, [authorize the edge node](/en/documentation/guides/application-development/automation/authorize-an-edge-node/). + diff --git a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx index 4dfef76adb..6f60fb164b 100644 --- a/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx +++ b/apps/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx @@ -50,7 +50,7 @@ All services linked to Nodes will be orchestrated and configured from the moment The orchestration is done sequentially and respects the dependencies between resources and triggers needed for its configuration. -Learn more about the [Azion Orchestrator agent installation](/en/documentation/guides/application-development/automation/install-orchestrator-agent/). +To install the agent on a machine, refer to [Install the Orchestrator Agent](/en/documentation/guides/application-development/automation/install-orchestrator-agent/). --- diff --git a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx index 65049fa653..a467dcbf31 100644 --- a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/avancado/explorar-uso/explorar-uso.mdx @@ -1,9 +1,8 @@ --- title: Como o Orchestrator funciona description: >- - Como o Orchestrator Agent transforma um dispositivo em um node gerenciado, - como os serviços e os resources deles chegam a esse node e como o agente os - mantém no estado que você definiu. + Como o Orchestrator Agent transforma uma máquina em um node gerenciado, como + os serviços chegam a ele e como o agente mantém os arquivos no estado definido. permalink: /documentacao/plataforma/orchestrator/explore-uso/ meta_tags: >- Orchestrator, Orchestrator Agent, node, autorização de node, serviços, @@ -35,7 +34,7 @@ O agente faz o trabalho no node, e o Azion Console guarda a configuração. A Az Um node novo aparece na lista **Edge Nodes** do Azion Console com o status `Waiting Authorization` e não recebe nenhum serviço até que você o autorize. A lista identifica cada node pelo hash que ele usou para se registrar, na coluna **HashId**. Depois da autorização, o node pode levar até 10 segundos para que serviços possam ser orquestrados nele. -Essa etapa é um bloqueio intencional. O registro precisa apenas do token, e a autorização adiciona a aprovação de uma pessoa antes que uma máquina receba seus serviços e a configuração deles. O custo é uma etapa manual por node, que o Console reduz ao autorizar vários nodes em uma única ação. Os passos estão em [Autorizar um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/). +No Azion Console, você pode autorizar vários nodes em uma única ação. Os passos estão em [Autorizar um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/). --- @@ -48,11 +47,11 @@ Um serviço é a descrição de um software, guardada na lista **Edge Services** Um resource Shell Script roda em um ou mais de três triggers. **Install** roda primeiro, quando o serviço chega ao node. **Reload** roda depois que todos os resources do serviço são instalados, e de novo sempre que o vínculo entre o serviço e o node muda, por exemplo quando o valor de uma variável muda. **Uninstall** roda quando o serviço sai do node. -O conteúdo de um resource pode ter dois tipos de marcadores. Uma variável, escrita `{{ VARNAME }}`, recebe um valor que você define, então o mesmo serviço pode escutar na porta 3306 em um node e na porta 3307 em outro. Um fact, escrito `{{ FACT_NAME }}`, recebe um valor que o agente lê do node, como a arquitetura, o sistema operacional, o número de CPUs ou a memória. Não é possível sobrescrever um fact. As listas completas estão na [referência de Services](/pt-br/documentacao/plataforma/orchestrator/edge-services/#variables). +O conteúdo de um resource pode ter dois tipos de marcadores. Uma variável, escrita `{{ VARNAME }}`, recebe um valor que você define, então o mesmo serviço pode escutar na porta 3306 em um node e na porta 3307 em outro. Um fact, escrito `{{ FACT_NAME }}`, recebe um valor que o agente lê do node, como a arquitetura, o sistema operacional, o número de CPUs ou a memória. Não é possível sobrescrever um fact. A referência de Services lista as [variáveis predefinidas](/pt-br/documentacao/plataforma/orchestrator/edge-services/#variables) e os [facts](/pt-br/documentacao/plataforma/orchestrator/edge-services/#facts). --- -## Vincular um serviço a um node +## O vínculo entre um serviço e um node Um serviço não roda em lugar nenhum até que você o vincule a um node. Um vínculo nomeia o serviço, o node e os valores das variáveis para esse node. Assim, um serviço vinculado a vários nodes roda em todos eles com valores adequados a cada máquina. Apenas um serviço ativo pode ser vinculado. @@ -64,17 +63,28 @@ Um serviço muda em um só lugar e chega a todos os nodes vinculados a ele. Quan O agente recebe a configuração do node dele como um manifesto, que carrega os resources dos serviços vinculados ao node. Cada manifesto tem um número de versão, e o agente registra em log cada versão que aplica. O agente aplica um manifesto em ordem, um resource por vez, e respeita as dependências entre os resources e os triggers de que eles precisam. +O diagrama mostra um node recebendo o manifesto dele. As setas contínuas levam a configuração e as ações que o agente executa no node, e a seta grossa leva o log que o agente grava. Cada rótulo começa com o número do passo abaixo. + ```mermaid %%{init: {"layout": "elk", "themeVariables": {"fontSize": "13px"}, "flowchart": {"nodeSpacing": 24, "rankSpacing": 36, "padding": 8, "wrappingWidth": 150, "useMaxWidth": true}, "sequence": {"width": 120, "actorMargin": 30, "useMaxWidth": true}}}%% flowchart TD - Console(["Azion Console: serviços, vínculos, variáveis"]) -->|"1 manifesto do node"| Agent["Orchestrator Agent no node"] - Agent -->|"2 grava cada resource"| Files[["arquivos em caminhos absolutos"]] - Agent -->|"3 roda Install, depois Reload"| Scripts[["resources Shell Script"]] - Agent -->|"4 Watcher verifica e restaura"| Files - Agent -.->|"5 registra versões e resultados"| Logs[("logs no node")] + Console["Azion Console"] + Agent["Orchestrator Agent"] + Files[["arquivos provisionados"]] + Scripts[["resources Shell Script"]] + Logs[("logs no node")] + Console -->|"1. manifesto"| Agent + Agent -->|"2. grava"| Files + Agent -->|"3. Install, Reload"| Scripts + Agent -->|"4. restaura desvio"| Files + Agent ==>|"5. log"| Logs ``` -O diagrama mostra um node recebendo o manifesto dele. As setas contínuas levam a configuração do Azion Console até o node, e a seta pontilhada leva o registro que o agente mantém no node. +1. O node recebe um manifesto com os resources dos serviços vinculados a ele e os valores das variáveis de cada vínculo. +2. O agente grava cada resource no caminho absoluto dele, um resource por vez. +3. O agente roda o trigger Install de cada resource Shell Script, depois o Reload. +4. O Watcher verifica os arquivos provisionados periodicamente e restaura qualquer arquivo que tenha desviado do último manifesto aplicado. +5. O agente registra em log a versão do manifesto que aplicou e o resultado de cada verificação do Watcher. Enquanto um manifesto é aplicado, o agente expõe duas variáveis predefinidas para os scripts. `CHANGESET_ADD_PATH` aponta para um arquivo com a lista de caminhos adicionados ou modificados neste manifesto, e `CHANGESET_RM_PATH` aponta para um arquivo com a lista de caminhos removidos ou modificados. Um script pode lê-las para agir apenas sobre os arquivos que mudaram. @@ -84,7 +94,7 @@ Enquanto um manifesto é aplicado, o agente expõe duas variáveis predefinidas Depois que um manifesto é aplicado, o agente mantém os arquivos no estado que ele descreve. Uma parte do agente chamada Watcher executa um grupo de workers periodicamente. Os workers verificam cada arquivo provisionado e o comparam com o último manifesto aplicado. Um arquivo que foi modificado ou removido é restaurado. -O Watcher protege o node contra desvios, e essa proteção tem um custo: o Azion Console é o único lugar para mudar um arquivo provisionado. Uma edição local no node é revertida na próxima verificação, e não é possível desativar o Watcher. Toda mudança, inclusive uma urgente, entra no serviço. Arquivos que o serviço não provisiona ficam fora do escopo do Watcher. +O Watcher protege o node contra desvios, e essa proteção tem um custo: o serviço e os vínculos dele são os únicos lugares para mudar um arquivo provisionado. Uma edição local no node é revertida na próxima verificação, e não é possível desativar o Watcher. Toda mudança, inclusive uma urgente, entra no serviço. Arquivos que o serviço não provisiona ficam fora do escopo do Watcher. --- diff --git a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx index de3d6cb513..457151d4a9 100644 --- a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/autorizar-node/autorizar-node.mdx @@ -71,13 +71,15 @@ Confira a [documentação da API Azion](https://api.azion.com/) e a [especifica +Depois da autorização, um edge node pode levar até 10 segundos para que serviços possam ser orquestrados nele. + ## Autorize vários edge nodes de uma vez -No Azion Console, você pode autorizar vários edge nodes em uma única ação: +Para autorizar vários edge nodes em uma única ação no Azion Console: -1. Acesse o [Azion Console](/pt-br/documentacao/guias/plataforma/conta-e-billing/como-acessar-o-azion-console/) > **Edge Nodes**. -2. Selecione os edge nodes que você quer autorizar. Para selecionar todos os edge nodes da lista, marque a primeira caixa de seleção à esquerda do cabeçalho da lista. -3. No canto superior direito, clique em **Actions** e selecione **Authorize**. -4. Clique em **Confirm**. +1. Acesse [Azion Console](https://console.azion.com/) > **Edge Nodes**. +2. Selecione os edge nodes que você quer autorizar. Para selecionar todos os edge nodes da lista, selecione a caixa de seleção no cabeçalho da lista. +3. Selecione **Actions** e depois selecione **Authorize**. +4. Selecione **Confirm**. -Uma mensagem de confirmação aparece. Depois da autorização, um edge node pode levar até 10 segundos para que serviços possam ser orquestrados nele. +Uma mensagem de confirmação aparece. diff --git a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx index 1ef4c62ecb..07c49450dd 100644 --- a/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/deploy-jornada/configurar-node/instalar-orch-agent/instalar-orch-agent.mdx @@ -69,8 +69,10 @@ Se o seu sistema operacional não tiver um gerenciador de serviços (como `syste sudo ./edge-orchestrator start --foreground ``` -:::note +:::note[nota] O Orchestrator Agent grava o log dele em `/var/log/azion/edge-orchestrator.log`. ::: +A máquina agora aparece na lista **Edge Nodes** do [Azion Console](https://console.azion.com/) como um edge node com o status `Waiting Authorization`. A coluna **HashId** mostra o hash que o edge node usou para se registrar. Antes que serviços possam rodar nele, [autorize o edge node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/). + diff --git a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx index cf958281cf..6d74187ffc 100644 --- a/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx +++ b/apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx @@ -26,8 +26,8 @@ Com o Orchestrator, você pode: | - | - | | Node | [Instalar o Orchestrator Agent](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/instalar-orchestrator-agent/) | | Node | [Autorizar um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/autorizar-edge-node/) | -| Services | [Criar um serviço](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/) | -| Services | [Vincular um serviço a um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/vincular-servico/) | +| Serviços | [Criar um serviço](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/) | +| Serviços | [Vincular um serviço a um node](/pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/vincular-servico/) | Para entender como o agente, os nodes e os serviços funcionam juntos, consulte [Como o Orchestrator funciona](/pt-br/documentacao/plataforma/orchestrator/explore-uso/).