EN
Español
English
Português
    Cloud Infrastructures

    Cloud Infrastructures – Configuration of Subscriptions

    The module Cloud Infrastructures in ADM allows you to configure your cloud service subscriptions Microsoft Azure, Amazon Web Services (AWS) and Google Cloud Platform (GCP), to synchronize information from the virtual machines or compute instances registered in each subscription and compare them to the devices discovered in ADM. This way, you can identify the virtual machines that have the ADM agent and those that are not.

    Each provider defines its own synchronization scope:

    Platform Scope of the subscription Resources that sync
    Azure An Azure subscription. Subscription VMs.
    AWS An AWS account and the regions selected in the configuration. EC2 instances in each selected region.
    GCP A Google Cloud project. Compute instances of all project zones.

    Prerequisites

    Before you set up a subscription, make sure you meet the following general requirements:

    • Access to the ADM console with the necessary permits for the Configuration and visualization of Cloud Infrastructures.
    • In deployments on-premises, Internet connectivity is required to consume the cloud provider’s services.

    Each provider requires a read-only credential about the resources to be synchronized.

    Microsoft Azure

    • One Service principal in Azure (application) with assigned permissions on the resources to be synchronized.
      This entity is used to securely authenticate to Azure services and must have, at a minimum, the Reader, which can be granted at the level of:

    • Subscription
    • Resource Group
    • Specific resource
    The service principal must include the following information:  
    
    • Application ID (Client)
    • Client Secret
    • Tenant ID (Organization)

    ⚐ Note:
    When permission is assigned at the Resource Group or Specific Resource, it is important to consider that a Virtual Machine in Azure depends on other associated resources, such as Discs, Network Interfaces (NICs) and Virtual Networks (VNet). If the service principal does not have permissions on these associated resources, the VM information will be synchronized in a partial and it will not be possible to obtain all of its data.

    Amazon Web Services (AWS)

    • One IAM user with a Access key (Access Key ID and Secret Access Key) in the AWS account to be synchronized. Each configuration in ADM covers a single AWS account.
    • The IAM user must have only read-only permissions, equivalent to the Reader of Azure. Assign the following permissions:
    Permission Information you can consult
    ec2:DescribeInstances EC2 instances: state, type, zone, tags, public IP, and CPU.
    ec2:DescribeVolumes The size of the EBS volumes associated with each instance.
    ec2:DescribeImages The image (AMI) from which the operating system is derived.
    ec2:DescribeInstanceTypes RAM of each instance type.
    ec2:DescribeRegions Catalog of enabled regions in the account.
    sts:GetCallerIdentity Identity of the credential, to verify that it corresponds to the configured account.

    ⚐ Notes:

    • The secret access key is only displayed in the AWS console at the time of creation. Keep the key in a safe place before closing the creation window.
    • Create the IAM user without a route, that is, with the default AWS route (/). ADM does not support IAM users created with a custom path, such as /equipo/usuario-adm; With that type of user, it is not possible to configure or synchronize the subscription.

    Google Cloud Platform (GCP)

    • One Service Account in the Google Cloud project to be synced, with the Compute Visualizer (roles/compute.viewer). This role grants read-only permissions on Compute Engine, equivalent to the role Reader and allows you to query the project instances, machine types, and the images or licenses from which the operating system is derived.
    • The Compute Engine APIs enabled in the project.
    • One JSON key of the service account.

    To get your credential in the Google Cloud console:

    1. Select the project to sync.

    2. In APIs and services > Library, search Compute Engine API and verify that it is enabled.

    3. In IAM and Management > Service Accounts, create a service account, and assign the role to it Compute Visualizer.

    4. On the Key points of the service account, select Add Key > Create New Key, choose the type JSON and download the file.

    5. Open the downloaded file and locate the value of the client_id. This value is entered in the Client ID when you create the subscription in ADM.

    ⚐ Note: If the Compute Engine API is not enabled on the project, synchronization cannot query the instances, even though the service account has the required role.


    Configuring permissions in the ADM console

    To manage subscriptions and view Synced devices, the user must have specific permissions:

    1. Enter the screen Configuration and select the menu Roles and permissions, located in the General.



    2. On the permissions tab, find the Cloud Infrastructure and enable the following options:

    • View Screens: It allows access to the screens of devices and subscriptions of Cloud Infrastructures.
    • Manage Display: Allows you to create, edit, sync, and delete subscription configurations. This permission requires that it is also enabled View Screens.

    3. Click the Save to apply the changes.

    ⚐ Note: Permits Cloud Infrastructure are enabled by default for roles Administrator and DeviceManager, and apply equally to Azure, AWS, and GCP subscriptions.


    View Subscription List

    1. Go to the screen Configuration and select the menu Cloud Infrastructures, in the ADM.


    2. On the main screen of Cloud Infrastructures You can perform the following operations:

    • View a Summary of each subscription (name, platform, subscription ID, and last sync date).
    • Select records individually.
    • Searching the list above the fields name or Subscription ID.
    • Sort columns ascending or descending.
    • Switch pages using the Pager located at the bottom.
    • Check in the lower right corner for the Total Records.
    • Create a new one Subscription Settings.

    The Column Platform Identifies the provider of each subscription (AZURE, AWS or GCP). The value of the column Subscription Depends on the platform:

    Platform Column Value Subscription
    Azure Subscription ID
    AWS IAM Username
    GCP Client ID

    ⚐ Note: To edit, sync, or delete, select a record in the listing.


    Create a new subscription configuration

    1. On the screen Cloud Infrastructures, click the NEW.



    2. In the field Platform, select the cloud provider: Azure, AWS or GCP. The panel Configuration Data displays only the fields of the selected platform.



    3. Fill in the required fields based on the selected platform, according to the tables in this section. The following fields are common to all three platforms:

    Field Obligatory Description
    Subscription Name Yes Custom name to identify the subscription in ADM (minimum 6 and maximum 50 characters, no spaces at the start or end). The name must be unique among all subscriptions, regardless of platform.
    Enabled Yes Subscription configuration status.
    Schedule Sync No Allows access to the modal Schedule Sync to define the update periodicity.


    Azure fields

    Field Obligatory Description
    Subscription ID Yes Subscription ID in Azure (20 to 50 characters). Two configurations with the same subscription ID are not allowed.
    Service ID Yes Service principal ID in Azure (20 to 50 characters).
    Service password Yes Secret key associated with the service entity (minimum 6 and maximum 50 characters).
    ID Tenant Yes Tenant ID in Azure (20 to 50 characters).


    AWS Fields

    Field Obligatory Description
    Access key ID Yes IAM user passkey ID (minimum 16 alphanumeric characters in uppercase, no spaces at the start or end).
    Secret access key Yes Secret access key associated with the access key ID (minimum 16 characters, no spaces at the start or end). The value is shown masked.
    IAM Username Yes The name of the IAM user used for synchronization. Only letters, numbers, and characters are supported + = , . @ _ -. The user must be created without a path in AWS. Two configurations with the same IAM username are not allowed.
    AWS Account ID Yes AWS account identifier (12 to 20 numeric digits).
    Regions Yes AWS Regions whose EC2 instances are synchronized. Select one or more regions from the list.


    Selected regions are displayed below the field Regions. To check out a region, click the X of the region.

    ⚐ Note: Synchronization queries only the selected regions. The synchronization time increases with the number of regions configured, so it is recommended that you select only the regions in which your account has EC2 instances.


    GCP Fields

    Field Obligatory Description
    Client ID Yes Client ID (client_id) of the Google Cloud service account (minimum 6 characters). Must match the value of the JSON file. Two configurations with the same customer ID are not allowed.
    Service Account JSON Key Yes Service account JSON file downloaded from the Google Cloud console. Click the attach icon next to Upload JSON file, and select the .json. The contents of the file are not displayed on the screen.

    ⚐ Note: The GCP subscription synchronizes instances in all zones and regions of the project, without the need to select them in the configuration.


    ⚐ Notes:

    • The Schedule Sync It will only be available if the subscription settings are in the Active.
    • If any field does not meet the validations, the system displays the corresponding message below the field and does not allow saving.


    4. Click the Save to finish the creation. The system will display the message: “The subscription was successfully created”.

    ⚐ Notes:

    • In a GCP subscription, the system rejects the JSON file if it does not correspond to a service account credential or if your client_id Doesn’t match the field Client ID.
    • Credentials are stored encrypted and are not displayed in plain text in the console.


    Edit a subscription setting

    1. Select the subscription from the listing.

    2. Click on the Edit



    3. A modal will open where you can modify only the fields that each platform allows:

    Platform Editable fields Fields that cannot be modified
    Azure Subscription Name, Service ID, Service password, subscription status, and Schedule Sync. Subscription ID and ID Tenant.
    AWS Subscription Name, Access key ID, Secret access key, Regions, subscription status, and Synchronization. IAM Username and AWS Account ID.
    GCP Subscription Name, Service Account JSON Key, subscription status, and Synchronization. Client ID.

    The synchronization schedule can only be edited if the subscription status is Active.

    In an Azure subscription, the Service password stored is retained if the field is not modified. To rotate the credential, enter the new service password.



    In an AWS subscription, the Secret access key stored is retained if the field is not changed. To rotate the credential, enter the new access key.



    In a GCP subscription, upload a file to Service Account JSON Key only if you want to replace the current key; if you do not upload a file, the stored key is retained.



    4. Click the Save to apply the changes. The system will display the message: “Subscription was successfully updated”.

    ⚐ Notes:

    • The system does not allow you to upgrade subscriptions with a Subscription Name duplicate.
    • If the subscription was created without a sync schedule, manually enable the status in the modal to configure it.
    • When you retire a region from an AWS subscription, subsequent synchronizations stop querying that region. Synchronized instances in that region are removed from inventory in the next synchronization.


    Delete a subscription setting

    Deleting a subscription will also delete the data on the VMs or synchronized instances associated with it, along with their synchronization schedule and stored credential.

    1. Select the subscription from the listing or open the detail modal and click the ELIMINATE.

    2. The system will display a confirmation modal.


    3. Click Accept to confirm the deletion or in Cancel to skip the action.

    4. If the deletion is confirmed, the system will display the message: “Subscription has been successfully deleted”.

    ⚐ Notes:

    • This action is irreversible: the associated synchronization data will also be deleted.
    • Only deleting subscriptions is allowed one by one. Multiple deletion is not available.
    • If the subscription is in a state Inactive, it can also be deleted.


    Schedule Sync

    Synchronization scheduling can be done at the time of creating a new subscription or later from the editing of the configuration.

    1. Click the Synchronize to access the modal Schedule Sync.


    2. The system offers two synchronization modes:

    • Run now: It performs an immediate synchronization, executed only once.


    • Program: Run an immediate sync and continue to sync automatically and indefinitely at intervals of 12 hours, 1 day or 7 days.



    3. To apply the schedule, click CONFIRM SYNCHRONIZATION.

    ⚐ Notes:

    • If you don’t want to apply changes, click CANCEL to close the modal.
    • The schedule will only run when the subscription configuration is in the Active. If you change to Inactive, scheduling will be disabled.


    On-demand synchronization

    1. Select the active subscription settings in the listing.

    2. Click the SYNCHRONIZE.


    3. During the process, the screen will remain inactive. When finished, the message will be displayed: “Synchronization successful”.

    4. The countryside Last Sync Date It will automatically update in the table.

    ⚐ Notes:

    • On-demand synchronization is not recommended when the subscription has a high number of virtual machines or instances assigned. In these cases, it is recommended to use the scheduled synchronization option.
    • Only subscriptions are allowed to be synced one by one. Multi-sync is not available.
    • If the subscription is in a state Inactive, the SYNCHRONIZE it is not enabled.
    • If a subscription doesn’t show a last sync date, it has never been synced.
    • In the event of a synchronization error, the system will generate the corresponding alert.


    Purpose of synchronization

    Synchronization (scheduled or on-demand) queries the information from the VMs or instances registered with the cloud provider and stores it in the ADM database:

    • Azure: VMs in your subscription.
    • AWS: EC2 instances in each region selected in the configuration. If one region fails or denies access, the other regions synchronize normally.
    • GCP: compute instances of all project zones.

    With this information, the system:

    • Compares VMs discovered in the cloud with ADM-registered devices.
    • Identifies VMs that have the ADM agent installed and those that are not.
    • It allows administrators to make decisions about the installation, updating of the agent in cloud environments.

    Each new synchronization updates existing records, without duplicating them, when the status, type, or tags of a VM or instance change. Attributes that are not reported by the provider are displayed with the value –.

    ⚐ Note: In AWS and GCP, if there are two or more subscription configurations from the same provider querying the same resources with different subscription names, each configuration synchronizes the instances independently. As a result, the inventory of Infrastructure displays each instance once for each configuration. We recommend that you create only one configuration per AWS account or GCP project.


    ⎘ Related Links: