/

Using an Existing OneAtlas Subscription

Accessing data with an existing OneAtlas subscription.


Introduction

If you have a OneAtlas subscription that you want to use in the console, you need to have the OneAtlas API Key and follow the steps below.

  1. Create an environment.

  2. Add the OneAtlas API key as a variable to this environment.

  3. Reference this environment in the relevant blocks in your workflow(s).

  4. Done.

If you already have a OneAtlas API key, we recommend creating a new one just for using it with UP42. This way, you can manage it separately from your other API key(s).

Step number 0 is generating a new OneAtlas API key. For completeness sake we document it here. Bear in mind that since this is an external service we cannot guarantee the accuracy of the information herein provided. There can be changes that we are not aware that render the instructions for generating the OneAtlas API key outdated. We aim for it to be as accurate as possible, but we cannot claim any strict adherence to the evolution of an external service interface.

Step 0: Create a OneAtlas API key

  1. Login to your OneAtlas account.

  2. Go to your API key listing page at: https://account.foundation.oneatlas.airbus.com/.

  3. Create a new API key and copy the value.

  4. Done.

The API key is only displayed once. If you fail to copy and save the value in a separate file, it will be lost and you will need to generate a new API key. Use only temporary storage for this purpose, either your own secret storage or any other secure storage system.

Step 1: Create an environment

  1. Login into the UP42 console.

  2. Go to the account settings at: https://console.up42.com/settings/account.

  3. Click on the Workspace button.

  4. Select the Environments tab that will take you to: https://console.up42.com/settings/workspace#environments.

  5. Click on the button towards the lower left corner of the window: Create Environment. Name your environment meaningfully.

  6. You now should have an empty environment.

  7. Done.

Here is a screenshot illustrating environment creation.

Enviroment creation
Enviroment creation

Now we can proceed to add the OneAtlas API key as an environment variable.

Step 2: Add the API key as an environment variable

  1. Add a variable to environment named ONEATLAS_API_KEY.

  2. Copy the OneAtlas API key into the value field and save the environment variable.

  3. Now you should see your newly created environment variable ONEATLAS_API_KEY with the masked value of your OneAtlas API key.

  4. Done.

A set of screenshots illustrating environment variable creation.

Add an environment variable
Add an environment variable

Add an environment variable.

Add the OneAtlas API key environment variable
Add the OneAtlas API key environment variable

Add the OneAtlas API key environment variable.

Save the variable
Save the variable

Save the variable.

You can add as many environment variables as you want, but make sure the names are different. For using OneAtlas data, please name the environment variable ONEATLAS_API_KEY, otherwise the credentials pass-through fails.

You can add as many environment variables as you want, but you cannot change their values. If you need to change the value of a variable, you need to create a new environment and add the variable with the respective changed value there.

Step 3: Reference the environment in a workflow

  1. Go the workflow page of the project where you want to enable the OneAtlas credentials pass-through.

  2. Select the desired workflow.

  3. Reference the environment in the relevant workflow block(s).

  4. Done.

Here is the illustrated sequence of steps to reference the environment in a workflow.

List all workflows for a project
List all workflows for a project

Go to the workflows for your project.

Select a particular workflow.
Select a particular workflow.

Select a workflow where you want to enable the OneAtlas credentials pass-through.

Reference the environment in the workflow
Reference the environment in the workflow

Reference the environment in the relevant block(s) of the workflow.

If you instantiate the workflow, by running a job, in the end your credit usage report makes evident that no credits where charged for the blocks using passed-through credentials.

Credit consumption for a block where the credentials were passed-through
Credit consumption for a block where the credentials were passed-through

No credits consumed for data retrieval from OneAtlas. Your credentials were passed-through.

Step 4: Done

Congratulations! You successfully ran jobs without getting charged on UP42 for the retrieved data through your OneAtlas subscription.