export-import init

Important: IBM Cloud Pak® for Data Version 4.6 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Initialize the cpd-cli export-import command.

Syntax

cpd-cli export-import init \
[--arch=<system-cpu-architecture>] \
[--cpdconfig=<cpd-configuration-location>] \
[--aux-pod-cpu-limit=<auxiliary-pod-cpu-limit-value>] \
[--aux-pod-cpu-request=<auxiliary-pod-cpu-request-value>] \
[--aux-pod-mem-limit=<auxiliary-pod-memory-limit-value>] \
[--aux-pod-mem-request=<auxiliary-pod-memory-request-value>] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--pvc-name=<persistence-volume-claim-name>] \
--profile=<cpd-configuration-profile-name> \
[--service-account=<openshift-container-platform-service-account>] \
[--verbose]

Arguments

The init command has no arguments.

Options

Option Description
--arch Provide the system architecture.
Status
Optional.
Syntax
--arch=<system-cpu-architecture>
Default value
x86_64
Valid values
x86_64
The 64-bit version of the x86 instruction set architecture.
ppc64le
The little-endian variant of the PowerPC 64-bit architecture.
--aux-pod-cpu-limit The CPU limit for the IBM® Cloud Pak for Data auxiliary pod.
Status
Optional.
Syntax
--aux-pod-cpu-limit=<auxiliary-pod-cpu-limit-value>
Default value
0 (unbounded)
Valid values
CPU limits are measured in CPU units. One CPU is equivalent to one CPU/core for cloud providers and one hyper-thread on bare-metal Intel processors. An m suffix in a CPU attribute indicates ‘milli-CPU’ (250m is equivalent to 25% of a CPU/core).
--aux-pod-cpu-request The CPU request for the IBM Cloud Pak for Data auxiliary pod.
Status
Optional.
Syntax
--aux-pod-cpu-request=<auxiliary-pod-cpu-request-value>
Default value
0
Valid values
CPU requests are measured in CPU units. One CPU is equivalent to one CPU/core for cloud providers and one hyper-thread on bare-metal Intel processors. An m suffix in a CPU attribute indicates ‘milli-CPU’ (250m is equivalent to 25% of a CPU/core).
--aux-pod-mem-limit The memory limit for the IBM Cloud Pak for Data auxiliary pod.
Status
Optional.
Syntax
--aux-pod-mem-limit=<auxiliary-pod-memory-limit-value>
Default value
0
Valid values
Memory can be expressed in various units, where one Mi is one IEC unit megabyte (1024^2), and one Gi is one IEC unit gigabyte (1024^3).
--aux-pod-mem-request The memory request for the IBM Cloud Pak for Data auxiliary pod.
Status
Optional.
Syntax
--aux-pod-mem-request=<auxiliary-pod-memory-request-value>
Default value
0
Valid values
Memory can be expressed in various units, where one Mi is one IEC unit megabyte (1024^2), and one Gi is one IEC unit gigabyte (1024^3).
--cpdconfig The Cloud Pak for Data configuration location.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--image-prefix Specify the image registry prefix.
Status
Optional.
Syntax
--image-prefix=icr.io/cpopen/cpd
Default value
icr.io/cpopen/cpd
Valid values
  • icr.io/cpopen/cpd
  • ${PRIVATE_REGISTRY_LOCATION}
--log-level The command log level.
Status
Optional.
Syntax
--log-level=info|debug|warn|error|panic
Default value
info
Valid values
debug
Debug messages are written to the log.
error
Error messages are written to the log.
info
Informative messages are written to the log.
panic
Panic messages are written to the log.
warn
Warning messages are written to the log.

--namespace

-n

 The namespace name in which the utility should operate.
Status
Optional.
Syntax
--namespace=<namespace-name>
Default value
${PROJECT_CPD_INSTANCE}
Valid values
A valid project (namespace) name.
--profile The profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.
--pvc-name Specify which persistence volume claim name to use for the command.
Status
Optional.
Syntax
--pvc-name=<persistence-volume-claim-name>
Default value
No default..
Valid values
Any valid persistence volume claim name.
--service-account Specify the Openshift Container Platform service account.
Status
Optional.
Syntax
--service-account=<openshift-container-platform-service-account>
Default value
cpd-admin-sa
Valid values
Any valid OpenShift® Container Platform service account name.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For more information, see Best practice: Setting up install variables.

Your docker image registry might be different than the provided examples.

Red Hat® OpenShift 4.x
Initialize the cpdtool first with PVC name for storage and the user and password of the Cloud Pak for Data administrator.
$ cpd-cli export-import init \
--namespace=${PROJECT_CPD_INSTANCE} \
--arch=x86_64 \
--pvc-name=<${PROJECT_CPD_INSTANCE}-pvc> \
--profile=${PROFILENAME} \
--image-prefix=icr.io/cpopen/cpd

Shared volume PVC

export-import requires that a shared volume PVC is created and bounded for use with the init command. If your PV is Portworx, ensure that it is shared enabled.
oc apply -f ${PROJECT_CPD_INSTANCE}-pvc.yaml

${PROJECT_CPD_INSTANCE}-pvc.yaml content:

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: ${PROJECT_CPD_INSTANCE}-pvc
spec:
  storageClassName: nfs-client
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 200Gi