You can help by commenting or suggesting your edit directly into the transcript. We'll review any changes before posting them. All comments are completely anonymous. For any comments that need a reply, consider emailing docs@inductiveautomation.com.
LESSON LIST
-
8:15Event Streams
-
3:59Kafka - Source Example
-
3:46Kafka - Handler Example
-
7:58Form Component - Structure and Widgets
-
3:39Form Component - Contingent Actions
-
4:55Form Component - Submission Management
-
4:21Form Component - Submitting Form Data in Offline Mode
-
13:37Form Component - Basic Form
-
2:13Offline Submissions
-
4:19File Association and Deep Links
-
11:38Drawing Component - Overview
-
16:14Drawing Component - Elements
-
5:05Drawing Component - Modification Tools
-
10:43Drawing Component - Layering and Alignment
-
2:14SQL Historian
-
4:55Deployment Modes
-
5:29Siemens Symbolic Driver - Browsing
-
4:46Siemens Symbolic Driver - Migrating
-
4:18Internal Secret Providers - Referenced Secrets
-
1:35Internal Secret Providers - Embedded Secrets
-
7:05Alarm Metrics Filtering and Aggregation
LESSON
Deployment Modes
Description
Learn about deployment modes, including how to create them, add resource overrides, and how to set a deployment mode as active.
Video recorded using: Ignition 8.3
Transcript
(open in window)[00:00] In this lesson, we'll learn how to create different versions of gateway configurations using deployment modes. To begin, I'll navigate to my Gateway's Platform page and then expand System and click Modes. I haven't created any deployment modes yet, so the page will be empty, but I can create a new one by clicking the Create Mode button here. Then I'll need to give this deployment mode a name, so I'll call this one "Staging". Optionally, you can provide a title and description if you'd like. I'll go ahead and give mine a quick description. Then I'll click Create Mode. Now I'll see my deployment mode show up in the data grid here. If I were to create another deployment mode, let's say, one called "Production", it would show up in the data grid as well, so I can see all deployment modes I've configured here with their names, titles, descriptions, and the number of resource definitions.
[01:03] Now that I have a mode, I'll show you how to actually add resource definitions to these modes. I'll start with a Singleton Gateway resource, like the Gateway Network Settings, which we'll find by navigating to Network > Gateway Network > Settings. At the top right of this page is the kebab icon that I can click for additional options. Now that I have a deployment mode configured on this gateway, I'll see an option for overriding this resource definition. I'll click Create Override. Then I just need to click this dropdown and choose the resource collection that I want to assign my override to. "Core" is just the default collection for the gateway, and any deployment modes we've configured will show up here. I'll choose Staging and then create the override. I'll see a banner above the settings that shows me that there are now two definitions for this resource. To the right of this banner is a dropdown that shows which version of the resource I'm currently viewing and editing. If I were to change one of these settings, let's say I uncheck the Enabled box and then click save changes, this resource will be different from the other versions of the resource where I haven't made this change.
[02:04] For example, I'll switch back to the core resource and the Enabled property is still checked. When I have a different version of a resource selected, I can click the kabob icon again to see some additional actions for the override, which include things like moving and removing. Moving just lets me assign it to a different deployment mode, and then remove will delete the override altogether. In addition to creating overrides, you can also create backup versions of a resource within the same menu. These versions are for redundant pairs and editing these will be just like editing an override. I'll select the configuration and then change one of the settings and click save changes. Now, if I switch between the primary and backup configurations, we'll see the difference shown here. Right now, the backup version only exists for the staging version of my resource, so I'd need to create a backup version for any other versions if I wanted that too. In order to remove this, I can open the menu and click Remove Backup Version.
[03:02] Be sure to click Save Changes when removing a version as the change won't actually be committed until you do. Next, I'll look at a named resource. I'll navigate to my database connections. I already have a couple SQL connections created, and I can click the menu to the far right of this connection and click Create Override to create another version. I'll choose my staging mode and click create again. I'll see a banner just like before, but this time I'll need to click Show All to see all versions of the resources. Now I can see that there's a core version of my connection and a staging version of the connection. Like before, I can click the menu and edit, move, or remove the override. To create a backup version, I can click the kebab icon at the top right of the popup to add a backup version. Now that I have some deployment modes with their own resource definitions available to me, I'll activate one. In order to do this, I'll need to have access to the gateway machine's operating system and open up the Ignition install directory. Then I'll need to open the "data" folder and edit the "ignition.conf" file.
[04:03] I'm running Ignition in a Docker container, so I have a terminal open to interact with mine. I'll put the path to this file on the screen for Windows and Linux. Then I'll need to find the additional Java parameters and add the following line where you supply the name of the deployment mode you wanna enable. When adding a new wrapper argument, replace the number here with whatever number comes next in your list of arguments. Make sure not to duplicate numbers. For me, it's my seventh argument, and I'm gonna choose my staging mode. Then I just need to restart my gateway, which I'll do via the gateway command line utility. Once the gateway starts up, I can see my current deployment mode via the banner at the top of the page, and if I ever wanna change it again, I can go back to the configuration file and change it.