Kernel configuration: General steps

Introduction

Certain Aura features requires the execution of preliminary tasks over Kernel to access its integrated resources and capabilities, such as APIs, datasets, etc.

The following sections outline the tasks that are common to all Aura features. Additionally, each of them will have their own specific requirements.

1. Check APIs publication in Kernel

• If the Aura feature uses a Kernel API, check if the API is published in Kernel: List of available APIS on Telefónica Kernel.

• If not, follow the guidelines in the document Publish an API in Kernel.

2. Check datasets publication in Kernel

Only necessary if the Aura feature requires datasets

• Identify the required datasets for the configuration of the feature:

  • Aura entities
    
    

• Check that these datasets are published in Kernel: List of available datasets on Telefónica Kernel.

• If not, ask the Kernel Team to publish the datasets in Kernel productive environment with the latest version.

3. Create a Kernel application

Accessing Kernel data requires the previous generation of an application (Kernel client), which must be configured with permissions to access specific datasets.

For certain Aura features, a specific Kernel application must be created from scratch. Other ones require the use of already existing Kernel applications, such as aura-bot-[environment], that must be specifically configured for this feature (Step 4).

• Ask the Kernel Team to create a new application with a specific name (id) in Kernel for your intended environment.
  Once the app is created, two parameters will be provided for securely accessing:
  • client_id: unique identifier of the consuming app acting as Kernel API client.
  • client_secret: password.

4. Assign purpose/scopes to the application

• Only in the case of data that contain personal information (PI-scopes), it is necessary to create a purpose in Kernel, that defines the reason for accessing information-related data. In this scenario, ask the Kernel Team to generate a purpose for the new application or the existing one required by the Aura feature.

• Ask the Kernel Team to generate the scopes required for the Aura feature, that define the access level to datasets (writing/reading permissions to/from Kernel datasets).
  
  Take into account the following considerations:

  • If a purpose is required, the scopes must be associated to it.
  • There are global admin scopes that are always mandatory for every app in order to write/read datasets:
    • admin:datasets:read
    • data:read
    • data:write
  • Additionally, each Aura feature requires its specific scopes.
  • The version number is not needed in the scopes.

Guidelines for Kernel configuration in specific Aura features

List of published guidelines that include specific Kernel configuration:

• Billing module operation