This document explains how maintenance and updates are performed on Edgeworx Cloud.
During a maintenance window, you can learn about service availability at status.edgeworx.io . You can find out about upcoming maintenance events in the changelog . And at any time, you can reach out to Edgeworx Support .
A maintenance event can affect one or both of Edgeworx Cloud or the attached edge nodes.
- Edgeworx Cloud maintenance: Edgeworx Cloud Portal and API .
- Edge Node maintenance: updates to the agent software and/or configuration installed on your edge devices.
Typical Edgeworx Cloud maintenance is invisible to the end user. That is to say, there is no interruption to service, and you may not have noticed that the update has occurred. We refer to this as a Zero-Impact Maintenance event. However, on occasion we may need to temporarily interrupt service to perform significant infrastructure or backend upgrades. We call this a Service-Impact Maintenance event.
When you add an edge node to your Edgeworx Cloud project, three software components are installed on the node:
- Edgeworx Agent interacts with Edgeworx Cloud to monitor the node’s status.
- ioFog Agent communicates with the Edgeworx Cloud ioFog backend to manage microservices on your node.
- Deviceplane Agent implements the keyless SSH access mechanism. It is also used by Edgeworx Cloud to perform updates to the agents themselves.
Node maintenance can affect one or more of these agents.
Node update process
This is a broad outline of the steps that can occur during node maintenance. Note that only some of these steps may occur for any particular maintenance event.
- Edgeworx Cloud initiates the update process by opening a connection with Deviceplane Agent,
and then executing an update script on the node via Deviceplane.
- Note that a login session may appear in your node’s log files. This is the update process at work.
- Edgeworx Agent:
- Edgeworx Agent’s software components may be updated.
- Edgeworx Agent’s configuration files may be modified.
- The Edgeworx Agent service may be restarted.
- ioFog Agent:
- ioFog Agent’s software components may be updated.
- ioFog Agent’s configuration files may be modified.
- The ioFog Agent service may be restarted.Note that this restart of ioFog Agent will not affect the microservices running on your node. They will continue to run without interruption.
- Deviceplane Agent:
- Deviceplane Agent’s software components may be updated.
- Deviceplane Agent’s configuration files may be modified.
- The Deviceplane Agent service may be restarted.
- What does not happen:
- Your applications and microservices running on your nodes will not be stopped or restarted.
- Your node (edge device) will not be restarted.
- Other than the changes to the agents listed above, no other changes are made to your node.
Sometimes a node will be offline during the maintenance period. What happens? When the node comes back online, the node’s Deviceplane Agent reestablishes its connection to Edgeworx Cloud. When Edgeworx Cloud observes that the node is back online, it will then initiate the deferred update process. The Deferred Maintenance Window is thirty days.
After that window closes - depending on the nature of that particular node update process - it may be necessary to re-register the node. From Edgeworx Cloud’s perspective, this effectively creates a new node. You would also need to re-deploy any microservices. Please contact Edgeworx Support if you need assistance with a node outside the deferred maintenance window.
Zero-Impact Maintenance, as you might expect, has zero impact on service availability. Most often, this type of maintenance is to improve backend services or infrastructure. If there are user-facing changes, you will be able to find information on those changes in the changelog .
During Service-Impact Maintenance, there is interruption to service.
- Edgeworx Cloud Portal will be unavailable. A visit to cloud.edgeworx.io in your browser will return an “Undergoing Maintenance” page.
- Edgeworx Cloud API routes will return a
503/Service UnavailableHTTP status code.
edgectlcommands will return an error.
Any user-facing changes from the update will be noted in the changelog .
We understand the importance of keeping our customers in the loop about upcoming maintenance. We have two classes of scheduled maintenance.
Regularly Scheduled Maintenance
For Regularly Scheduled Maintenance, you will receive an initial email notification at your account’s registered email address at least five business days before the maintenance window. If you have concerns about the maintenance event impacting your operations, please contact Edgeworx Support as early as possible.
Expedited Schedule Maintenance
For an Expedited Schedule Maintenance event, we aim to email you at least two days in advance. We realize that this is not a lot of time to prepare, so we make every effort to avoid expedited maintenance.
- You will receive an initial notification email for either Regularly Scheduled or Expedited Schedule Maintenance.
- You will be emailed a reminder the day before the maintenance window.
- You will be emailed again when the maintenance window opens.
- And, finally, you will be emailed one more time when the maintenance event concludes.
- Note that at any time, you can learn more about service availability at status.edgeworx.io .
- After the maintenance event concludes, you can find out about any changes or new features in the changelog .
- At any time, you can check on the availability of new
edgectlversions by executing
If you have any feedback about our process, feel free to start a discussion over at discuss.edgeworx.io . If you have a concern about an upcoming maintenance event impacting your operations, please reach out as early as possible to Edgeworx Support .