Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 7.68 KB

data-portability.md

File metadata and controls

82 lines (53 loc) · 7.68 KB
Raw
copyright lastupdated keywords subcollection
years
2024
2024-11-18
CIS
cis

{{site.data.keyword.attribute-definition-list}}

Understanding data portability for CIS

{: #data-portability}

Data portability{: term} involves a set of tools and procedures that enable customers to export the digital artifacts that are needed to implement similar workload and data processing on different service providers or on-premises software. It includes procedures for copying and storing the service customer content, including the related configuration that is used by the service to store and process the data, on the customer's own location. {: shortdesc}

Responsibilities

{: #data-portability-responsibilities}

{{site.data.keyword.cloud_notm}} services provide interfaces and instructions to guide the customer to copy and store the service customer content, including the related configuration, on their own selected location.

The customer is responsible for the use of the exported data and configuration for data portability to other infrastructures, which includes:

  • The planning and execution for setting up alternative infrastructure on different cloud providers or on-premises software that provide similar capabilities to the {{site.data.keyword.IBM_notm}} services.
  • The planning and execution for the porting of the required application code on the alternative infrastructure, including the adaptation of customer's application code, deployment automation, and so on.
  • The conversion of the exported data and configuration to the format that's required by the alternative infrastructure and adapted applications.

For more information about your responsibilities for CIS, see Understanding your responsibilities when using CIS.

Data export procedures

{: #data-portability-procedures}

CIS provides the mechanisms to export your content that's uploaded, stored, and processed when you use the service.

You can use the CLI and API to export settings and configurations that are used to process the customer's content. For example, you can export global load balancers, DNS records, advanced settings in zones, and page and firewall rules.

You cannot export custom certificates, advanced certificates, or universal certificates that Cloudflare manages for you.

Exporting CIS data with the CLI and API

{: #cis-export-cli-api}

The following table provides mechanisms to export the settings and configurations that are used to process configuration content through the means of the CIS CLI and API. The procedures given in the linked documentation should be followed and the output stored to ensure all necessary configuration data is available.

CLI API
ibmcloud cis access-apps \n ibmcloud cis access-certificates \n ibmcloud cis access-policies \n ibmcloud cis alert-webhooks \n ibmcloud cis authenticated-origin-pull-certificates \n ibmcloud cis certificates \n ibmcloud cis dns-records \n ibmcloud cis domains \n ibmcloud cis edge-functions-actions \n ibmcloud cis edge-functions-triggers \n ibmcloud cis firewalls \n ibmcloud cis glb-events \n ibmcloud cis glb-monitors \n ibmcloud cis glb-pools \n ibmcloud cis glbs \n ibmcloud cis instances \n ibmcloud cis origin-certificates \n ibmcloud cis page-rules \n ibmcloud cis ratelimit-rules \n ibmcloud cis waf-groups \n ibmcloud cis cis waf-overrides \n ibmcloud cis waf-packages \n ibmcloud cis waf-rules \n ibmcloud cis alert-policy list \n ibmcloud cis advanced-rate-limiting rules \n ibmcloud cis managed-waf rulesets \n ibmcloud cis managed-waf deployments list access apps \n list access certificates \n list access policies \n \n list alert webhooks \n list authenticated origin pull certificates \n list certificates \n list dns records \n list zones \n get edge functions actions \n list edge functions triggers \n list firewall rules \n list glb events \n list glb monitors \n list glb pools \n list glbs \n list instance rulesets \n list origin certificates \n list page rules \n list zone rate limits \n list waf rule groups \n list waf overrides \n list waf rule packages \n list waf rules \n list alert policies \n list advanced rate limiting rules \n list waf rules \n list waf deployments
{: caption="Exporting CIS data with the CLI and API" caption-side="bottom"}

Exported data formats

{: #data-portability-data-formats}

CIS supports the following data format and schema of the exported data, configuration, and application:

  • Export in JSON format only

    Example CLI using the ibmcloud cis glbs command:

    ibmcloud cis glbs DNS_DOMAIN_ID [-i, --instance INSTANCE] [--output FORMAT]

    {: pre}

  • Example API request using the list-all-load-balancers API:

    curl -X GET https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/load_balancers \
-H 'content-type: application/json' \
-H 'x-auth-user-token: Bearer xxxxxx'

    {: codeblock}

CIS doesn't support the export of other data formats and other schema of the exported data, configuration, and application, including the following:

Data ownership

{: #data-portability-ownership}

All exported data is classified as customer content. Apply the full customer ownership and licensing rights, as stated in the IBM Cloud Service Agreement{: external}.