Getting Started

TThis chapter describes additional preparation steps you can complete in the Fleet Command User Interface, including defining edge sites, adding an application, and performing updates. The guide also covers setting up a virtual representation of the physical system at the edge location and managing that system remotely.

Adding a Location

A location defines an edge location/site such as a retail store or hospital where edge deployments will be installed.

  1. To add a location, navigate to the Locations page and click Add Location on the right side of the page.

    ../_images/getting-started-12.png
  2. You will then be prompted to add a location.

    ../_images/getting-started-13.png
    • Location Name: Name the location.

    • Description: Choose a description for the location.

    • Version: Choose the Fleet Command version for the location.

    • Address: List the location’s physical address.

    Note

    The Location Name can only contain digits (0-9), lowercase letters (a-z), or a dash (-). The Location Name must also start with a lowercase letter. Fleet Command Versions are supported for the previous two months only, and it is recommended to select the latest version available for all new locations.

  3. Once you have added your first location, it will appear in the Fleet Command location list.

    ../_images/getting-started-14.png
  4. You can view all of your locations on the Locations page.

    ../_images/getting-started-15.png
  5. There is additional information under each location, such as system status, the IP address of the system, and description. You may also see messages or issues from the location or system.

    ../_images/getting-started-16.png

Note

To perform a Location Update or Location Removal, refer to the Maintaining Deployments section.

Location Status

The icon to the left of a location illustrates the current status. The following screenshot shows a green icon indicating that the location is online and ready to accept deployments.

../_images/getting-started-17.png

The following table describes the three possible system statuses for a location:

Status

Symbol

Description

Online

check-mark

Location is ready to accept deployments.

Issue State

caution

Issue: Expand the location for more information.

Offline

offline

Location cannot be contacted, but applications may still be running.

Update in Progress

update

The location is updating with a newer version.

Note

If your location experiences an issue, more information is available by expanding the location.

Adding a System

A system is a virtual representation of a physical system at the edge location. After the system is deployed at the edge location, it should be paired with a system in Fleet Command. This helps ensure that when software is deployed in Fleet Command, it is deployed to the physical system.

The first system added to the location is considered the controller-worker. The controller-worker is a Kubernetes master node with a taint to run workloads. Additional nodes added to the location will be regarded as worker nodes.

../_images/getting-started-18.png
  1. To add a system, click on the ellipsis for a location and select Add System.

    ../_images/getting-started-19.png
  2. You will then be prompted to add a new system.

    ../_images/getting-started-20.png
    • System Name: Choose a name for the new system.

    • Description: A description of the new system.

      • This is an excellent place to track the BMC IP address of a system.

    Note

    The System Name can only contain digits (0-9), lowercase letters (a-z), or a dash (-). The System Name must also start with a lowercase letter.

  3. Once a system has been added to a location, an activation code will be provided through Fleet Command. The activation code will pair a system in Fleet Command with a physical system device at the edge location.

    ../_images/getting-started-21.png ../_images/getting-started-22.png
  4. The activation code will pair a system in Fleet Command with a physical server device at the edge location.

    Note

    Some preparation at the physical edge site is needed before the system is ready to accept the activation code. Refer to the Edge Site Preparation section for more information.

    Important

    If the measured boot failed for your edge site, you might see the following issue banner for the system.

    ../_images/getting-started-27.png
  5. To view all systems associated with a location, click on the caret for a location.

    ../_images/getting-started-23.png
  6. The systems associated with the location are now viewable.

    ../_images/getting-started-24.png

Note

To remove a system, refer to the Managing Deployments section.

System Status

The icon shown in the Status column indicates the current status. The following screenshot shows a green icon indicating that the system is ready to run applications.

../_images/getting-started-25.png

The following table describes the three possible system statuses:

Status

Symbol

Description

Connecting

update

The system is connecting, updating, or rebooting.

Ready

check-mark

The system is ready to run applications.

Issue

caution

Issue: Refer to the banner for additional information.

../_images/getting-started-26.png

Note

If your system experiences an issue, a badge will appear to your location status, and a banner will appear with details regarding the issue under your location. There are two types of banners: an issue banner, and the other is a message banner.

System Details

To view additional information on the system, click System Details using the ellipsis.

../_images/getting-started-29.png

System details will appear on the right side of the window displaying the system information and advanced networking details.

../_images/getting-started-30.png

Note

Multi-Instance GPU (MIG) support, a feature that allows secure partitioning of GPUs into separate GPU instances, can be enabled from the System Details panel after deploying an application. Refer to Multi-Instance GPU for more information.

Pairing a System with Fleet Command

To pair a system with Fleet Command, it is essential the steps below are completed:

  1. Download the Fleet Command Discovery image from the Fleet Command Settings page to your local laptop or desktop (Ubuntu Linux, Mac, or Windows). The image will be named similar to the following convention: fc-<version>-<arch>.iso, and administrators should always use the ISO version that matches the Location version they will be deploying. For additional information, refer to Adding a Location.

    Note

    For additional security, validate the system image with the available checksum from the Settings page as shown below. Refer to the checksum validation for more information.

    ../_images/getting-started-28.png
  2. There are two ways you can load the Fleet Command Discovery Image into your system

Booting from Virtual Media

Follow the instructions from each individual system provider to load the Fleet Command Discovery Image as a virtual media.

Booting from USB

The correct system image is loaded onto a USB flash drive. The following steps can be used to create a bootable USB flash drive with the Fleet Command Discovery image:

  1. Locate a 16GB USB flash drive.

  2. On your local laptop or desktop, use these instructions to burn the image:

    • Ubuntu Linux: For creating a bootable USB flash drive on Ubuntu, use the Startup Disk Creator application on your Ubuntu computer. Follow the simple instructions outlined in the Ubuntu tutorials here.

    • Apple macOS: For creating a bootable USB flash drive on your Mac, follow the instructions outlined in the tutorial here.

    • Microsoft Windows: For creating a bootable USB flash drive on your Windows PC/Laptop, follow the instructions outlined in the tutorial here.

    • The USB flash drive has now been loaded with a Fleet Command system image and is ready to be used to boot systems.

  3. The following steps are used to configure the system for the Fleet Command Stack installation:

    • Connect a monitor and a keyboard either directly to the system or remotely access the system via the platform’s IPMI interface.

    • Power on the system

    • Update firmware as needed to meet company policies for systems deployed with limited access.

    • Access the BIOS settings

    • Set the system time to the local time (Fleet Command Stack will automatically set the OS time to local UTC)

  4. Follow the instructions from each individual system provider to enable TPM and Secure Boot.

  5. Activate the system once the system has been appropriately configured.

    Note

    It is essential to have your Fleet Command activation code for the next set of steps. The Fleet Command activation code is only valid for 12 hours after it is created.

  6. The following steps will activate the system with Fleet Command via the activation code:

    • Plugin the provided Fleet Command Discovery USB flash drive to the edge system

    • Reboot or power on the system

    • You will be prompted to create an administrator password. This password will be used to access the edge system in the future.

    ../_images/getting-started-03.png
    • Press Enter when finished.

    Note

    The Administrator password requirements are listed below. It is recommended that this password comply with any existing corporate password policy.

    • At least 14 and at max 128 characters long

    • At least one lowercase character

    • At least one upper case character

    • At least one digit

    • At least one of the following symbols: $,#@%^=./~_-!

  7. Network and NTP will be configured automatically by the Fleet Command Stack. Wait while the configuration is completed; it may take several minutes.

    ../_images/getting-started-04.png

    Important

    If the configuration is not completed automatically, it may require manual configuration in the Advanced Configurations dialog. You will need to select the network with access to the internet.

    ../_images/getting-started-05.png
    • You have an option to add the configuration manually in Advanced Configurations. To add the Advanced Configuration option press CTRL+C after you enter the Administrator password.

    • You can select Configure Network Interfaces if you have multiple network interfaces to choose the right one. Once you choose the correct network interface, you can either use DHCP or configure manually to configure the static IP. You will need to select the network with access to the internet.

    ../_images/getting-started-32.png
    • Once you choose the correct network interface, you can either use DHCP or configure the edge system with a static IP.

    • You will need to select the network with access to the internet.

    ../_images/getting-started-36.png
    • Example of static IP configuration screen.

    ../_images/getting-started-37.png
    • You can add the NTP servers with the Configure NTP option if you want to add any.

    ../_images/getting-started-33.png
    • If you want to add any proxy to the edge system, select Configure HTTP Proxy and add a proxy address.

    ../_images/getting-started-34.png
    • If you want to add any additional configuration, select Edit Configuration Manually and edit the configuration.

    ../_images/getting-started-35.png
  8. Enter the activation code.

    ../_images/getting-started-06.png
  9. Once the activation process has been completed, you will see the location change from “offline” to “online” in the UI. The system’s IP address is also shown in Fleet Command UI now.

Note

The installation and activation are a continuous process. If you cannot complete the installation and activation simultaneously, it is recommended that you complete the process later. If the activation code has expired, you will need to remove and add the system to the location again.

Once a system at the edge has been paired with a system in Fleet Command, you are now ready to deploy software to the edge using the Fleet Command interface.

Configuring Your System

Once your system is set up, you can configure for multi-instance GPU. For more information, refer to Multi-Instance GPU Configuration.

Accessing Your System

Once your system is set up, you can remotely access it using Fleet Command Remote Console. For more information, refer to Remote Console.

Adding an Application

An application defines what can be deployed to edge locations. The primary element of an application is the Helm chart which describes how the application will be deployed.

Note

To learn how to create an application for Fleet Command, refer to the Application Development Guide.

  1. To add an application, select Applications in the Fleet Command navigation menu.

    ../_images/getting-started-07.png
  2. Click Add Application on the right side of the page.

    ../_images/getting-started-08.png
  3. Fill in the details for the application.

    ../_images/getting-started-09.png
    • Display Name: This must be the unique name of the application.

    • Description: Create a description for the new application.

    • Helm Chart Name: The name of the Helm chart.

      Note

      You can create multiple applications with the same Helm Chart Name as long as the Display Name is unique.

    • Helm Chart Version: This must be the exact version of the application listed in the helm repository.

    • Helm Repo URL (no trailing slash): The user’s unique Helm repository URL where all of their helm charts are stored. Helm repository URL can be NGC Catalog Helm Charts or other Public Helm Repos or NGC Private Registry for maximum security.

  4. You can view all of your applications on the Applications page.

    ../_images/getting-started-10.png

For example, there are two applications listed on the following Applications page: Face Mask Detection App and Video Analytics Demo.

../_images/getting-started-11.png

Note

To remove an application, refer to the Managing Deployments section.

Creating a Deployment

Deployments join systems at physical edge sites with the applications hosted on Fleet Command in the cloud. Through a Fleet Command deployment, the Admin selects the application they would like to deploy and the locations they would like to deploy it to. The deployment will operate based on the application’s Helm chart and given configuration.

  1. To create a deployment, go to Fleet Command > Deployments. On the Deployments page, click Create Deployment in the top menu.

    ../_images/deploying-to-the-edge-01.png
  2. The Create Deployment page will display. Fill in the information for the deployment.

    ../_images/deploying-to-the-edge-02.png
    • Deployment Name: Enter a name for the deployment.

    • Locations: Select the location(s) to deploy to.

    • Security Overrides (Optional): Use this feature to override the default security settings for a deployment. Security overrides can only be selected on initial deployment creation and cannot be changed afterward without recreating the deployment. If security overrides are chosen, a message will be display on the Locations and Deployments pages. For detailed information on the options, refer to the Security Overrides section.

      Note

      Most security override options are only available with locations version 1.9.3 or newer. For versions older than 1.9.3, only the Allow system device access option is available.

    • Application: Select an application for the deployment.

    • Application Configuration: Add configuration overrides for this deployment if the application allows. Refer to Application Configuration for more information.

Checking Deployment Status

The icon listed in the Deployment Status column indicates the current status. The following screenshot shows a green icon indicating that the deployment is online and that the application is deployed to the location.

../_images/deploying-to-the-edge-04.png

The following table describes the three possible deployment statuses:

Status

Symbol

Description

Deploying

update

Application is deploying to the locations selected.

Online

check-mark

Application has deployed successfully with pod creation on the location.

Issue

caution

Expand the location for additional information.

Accessing the Application

Once the application has been deployed successfully, you can access the application using the Remote Application Access feature from Fleet Command. For more information on using this feature, refer to Remote Application Access.