User's Guide: Create Datasets

1.0 Introduction

A dataset contains information on how to securely retrieve remote data.

This includes the following:

  • A location such as a URL to an external storage service.

  • Credentials such as username, password, auth-token, and so on, which are stored securely in a KMS (currently this is Fortanix-Data-Security-Managers).

NOTE

  • A Credential is a fully user-provided object, for example: this can be a JSON string that contains the query param of the S3 pre-signed URL and the decryption key.

  • Credentials can be rotated through updates to datasets, all approved enclaves are allowed to refresh and get the latest credentials.

You can leverage these objects to provide data to enclaves securely.

Fortanix CCM’s EDP and EnclaveOS products can retrieve datasets and their credentials when run in an approved workflow. For more details about workflows, refer to User's Guide: Workflows.

2.0 Create a Dataset

To create a dataset.

  1. Click the Datasets menu item from CCM UI left navigation bar.  

    dataset-landing-screen.png

    Figure 1: Datasets

  2. On the Datasets page, click the CREATE DATASET button to create a dataset.  

    dataset-landing-screen-1.png

    Figure 2: Create Dataset

  3. In the Create new dataset form, enter the following details:

    • Name – the dataset name. For example: Dataset1.

    • Description (optional) – the dataset description.

    • Labels (optional)– attach one or more key-value labels to the dataset.

    • Group – Select the required group name from the drop down menu to associate this dataset with that group.

    • Location – the URL where the data can be accessed.

    • Long Description (optional)– enter the content in GitHub-flavoured Markdown file format. You can also use the Fetch Long Description button to get the Markdown file content from an external URL.

      Fetch Long Description Dialog Box.png

      Figure 3: Fetch Long Description

      The following is the sample long description in Markdown format:

      - Strikethrough Text
      ~~It is Strikethrough test..~~
      
      - Blockquote Text
      > Test Blockquote.
      
      - Bold
      **A sample Description.**
      
      - Italic
      *It is Italics*
      
      - Bold and Italic
      ***Bold and Italics text***
      
      - Link
      This is [Website](https://www.fortanix.com/)?
    • Credentials – the credentials needed to access the data.

    create-dataset-updated-field.png

    Figure 4: Create New Dataset

  4. Click the CREATE DATASET button to create the dataset.  

    create-dataset-1.png

    Figure 5: Dataset Created

3.0 Update a Dataset

To edit a dataset:

  1. In the dataset table view, select the dataset to edit.

  2. In the detailed view of the dataset, click the EDIT DATASET button to edit the dataset details. 

    edit-dataset-landing-screen.png

    Figure 6: Edit Dataset

  3. You can edit the dataset Name, Description, Location, Labels, and Credentials.

  4. Click SAVE after you edit the dataset. 

    edit-dataset-landing-screen-2.png

    Figure 7: Save Dataset

    NOTE

    You can also edit a dataset by clicking the overflow menu for a dataset table entry and selecting the EDIT DATASET option from the menu.

    Figure 8: Edit Dataset

4.0 Delete a Dataset

To delete a dataset:

  1. In the dataset table view, click on the dataset to delete.

  2. In the detailed view of the dataset, click the DELETE DATASET button to delete the dataset. 

    delete-dataset.png

    Figure 9: Delete a Dataset

  3. In the confirmation window, click DELETE to delete the dataset.

    NOTE

    You can also delete a dataset by clicking the overflowCCM_dataset10.pngmenu for a dataset table entry and selecting the DELETE DATASET option.

    Figure 10: Delete a Dataset