cli-plugin-azure

command module
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 22, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

README

Azure plugin for the Raito CLI

Software License Build status Code Coverage


Note: This repository is still in an early stage of development and still in experimental phase. At this point, no contributions are accepted to the project yet.

Raito CLI Plugin - Azure

This Raito CLI plugin will synchronize the users and groups from an Azure Active Directory account to a specified Raito Identity Store. Next to that it supports syncing Data Objects and Access Providers for the following Azure Services:

  1. Azure Data Lake

Prerequisites

To use this plugin, you will need

  1. The Raito CLI to be correctly installed. You can check out our documentation for help on this.
  2. A Raito Cloud account to synchronize your Azure Active Directory with. If you don't have this yet, visit our webpage at (https://raito.io) and request a trial account.
  3. At least one Azure account with Active Directory setup
    1. You'll need the Tenant ID of your directory
    2. Under 'App registrations', set up a new application for this integration. You'll need the Application (client) ID.
    3. In the newly created application go to 'Certificates & secrets' to create a new client secret
    4. In the newly created application go to 'API Permissions' and make sure the application has the permissions Group.Read.All, User.Export.All, User.Read and User.Read.All. Make sure these are approved. To do this, go to the 'Enterprise applications' menu in your AD Directory, find your application and go to 'Permissions'.

Usage

To use the plugin, add the following snippet to your Raito CLI configuration file (raito.yml, by default) under the targets section:

  - name: azure-ad1
    connector-name: raito-io/cli-plugin-azure-ad
    identity-store-id: <<Active Directory IdentityStore ID>>

    ad-tenantid: <<Your AD Tentant ID>>
    ad-clientid: <<Your AD Client ID>>
    ad-secret: "{{RAITO_AD_SECRET}}"

    azure-subscription-id: <<The ID of your Azure Subscription>>

Next, replace the values of the indicated fields with your specific values:

  • <<Your AD Tentant ID>>: the tenant ID as explained in the prerequisites above
  • <<Your AD Client ID>>: the Application (client) ID as explained in the prerequisites above
  • <<The ID of your Azure Subscription>>: the subscription ID you find in your azure portal

Make sure you have a system variable called RAITO_AD_SECRET with the client secret (see prerequisites above) as its value.

You will also need to configure the Raito CLI further to connect to your Raito Cloud account, if that's not set up yet. A full guide on how to configure the Raito CLI can be found on (http://docs.raito.io/docs/cli/configuration).

Trying it out

As a first step, you can check if the CLI finds this plugin correctly. In a command-line terminal, execute the following command:

$> raito info raito-io/cli-plugin-azure

This will download the latest version of the plugin (if you don't have it yet) and output the name and version of the plugin, together with all the plugin-specific parameters to configure it.

When you are ready to try out the synchronization for the first time, execute:

$> raito run

This will take the configuration from the raito.yml file (in the current working directory) and start a single synchronization.

Note: if you have multiple targets configured in your configuration file, you can run only this target by adding --only-targets azure1 at the end of the command.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL