Adding code packages to a deployment space

Creating code packages for code developed in Cloud Pak for Data

If you developed code in Cloud Pak for Data by creating code files created in JupyterLab or R Studio in a Project with default Git integration, you can import a ZIP archive from your Github repository to your deployment space to create a code package along with all the other assets in your Project.

The following diagram shows the options for use of IDEs with Git-based projects. You can import a code package into a deployment space on Cloud Pak for Data and deploy the code package or create a deployment job to run the code package.

Creating code packages for code developed outside Cloud Pak for Data

If you developed code outside Cloud Pak for Data, for example, by using PyCharm on your local workstation, you can use a ZIP archive and create a code package asset in your deployment space by using CPDCTL.

Ways to add code packages

The code package asset is created automatically when you add a ZIP archive to a deployment space. You can add code packages to your deployment space from the user interface or programmatically by using IBM Cloud Pak for Data Command Line Interface (CPDCTL).

• Adding code packages to a deployment space: You can add code packages to your deployment space during the process of creating a new deployment space from the user interface, or import code packages to an existing deployment space. For more information, see Adding code packages to a deployment space.
• Adding code packages programmatically: Use the CPDCTL command line interface to create and register code package assets in a deployment space. For more information, see Adding code packages programmatically.

Before you begin

You must have a ZIP archive file that contains your exported Project as a code package.

Creating a deployment space with code packages

Follow these instructions to add code packages to your deployment space:

1. From the Deployments page, click New deployment space.

2. Enter details for your deployment space.

3. In the Upload space assets section, upload your ZIP archive file that contains your code package files.

   

4. Click Create.

   

Creating and registering code package assets with CPDCTL

To create a code package asset in a deployment space by using CPDCTL, follow these steps:

1. Commit or push any changes to the project that you are working on.
2. Create a compressed file that contains all the assets that you want to move to the deployment space.
3. Download, install, and configure the CPDCTL command line interface for your operating system. Refer to CPDCTL.
4. Enable the code package module in CPDCTL:

   export CPDCTL_ENABLE_CODE_PACKAGE=1
   

5. Upload the compressed file to the storage associated with the deployment space:

   cpdctl asset file upload --path code_package/${FILE_NAME} --file ${LOCAL_FILE_PATH} --space-id ${SPACE_ID}
   

   Input parameters include:
   • FILE_NAME: The name of the compressed file in the storage associated with the deployment space
   • LOCAL_FILE_PATH: The path to the compressed file to be uploaded
   • SPACE_ID: The ID of the deployment space
6. Create a code package in the deployment space:

   cpdctl code-package create --file-reference code_package/${FILE_NAME} --name ${CODE_PACKAGE_NAME} --description ${CODE_PACKAGE_DESCRIPTION} --space-id ${SPACE_ID}
   

   Input parameters include:
   • FILE_NAME: The name of the compressed file in the storage associated with the deployment space
   • CODE_PACKAGE_NAME: The name of the code package in the deployment space
   • CODE_PACKAGE_DESCRIPTION: The description of the code package in the deployment space
   • SPACE_ID: The ID of the deployment space