Asset Repository

A guide to the Asset Repository.

Overview

IBM® Cloud Pak for Integration Asset Repository is an add-on to the IBM Cloud Pak for Integration that allows the user to store, manage, retrieve and search integration assets within the IBM Cloud Pak for Integration and its capabilities.

Users of the Cloud Pak are able to use the Asset Repository to share Integration assets across the platform capabilities. Storing assets, such as JSON schemas, within this repository allows them to be accessed directly within the user interface of certain Integration capabilities. For example, an OpenAPI specification asset stored in the repository can be directly imported within the IBM API Connect user interface.

In version 2019.3.2, it is possible to use remote Github repositories as a source for assets. This allows users to take advantage of the versioning capability offered by the remote repository. Note that assets stored in a remote repository are read-only in the 2019.3.2 release. See Remotes for more information.

Platform Navigator

You can access the Asset Repository through the Platform Navigator at https://Ingress Proxy hostname/Ingress path. Click the menu button.

home header bar

Requirements

You must meet the following dependencies before you create the Asset Repository. A Integration Specialist should carry out these tasks.
  • If your cluster has network access, you can use the IBM Entitled Registry to deploy capabilities. To use the Entitled Registry, you must first obtain an Entitlement key. Take the following steps.
    1. Obtain an Entitlement key from https://myibm.ibm.com/products-services/containerlibrary (IBM Container Library). Click Get an entitlement key if you are not on the entitlement page. Click IBM Cloud Pak for Integration. Copy the entitlement key presented. Use this key in the next step.
    2. Create a docker registry secret using a command similar to the following. kubectl create secret docker-registry prod-secret --docker-username=cp --docker-password=<entitlement-key> --docker-server=cp.icr.io

      Once this secret is created for the registry, you will use this secret in the product Helm chart ImagePullSecret field.

    If you are using a local repository, an imagePullSecret must be available within the namespace. If the images are contained in the target namespace of the Red Hat OpenShift container registry, you can use the deployer-dockercfg-<uid> secret for the namespace. Use oc get secret -n <namespace> to find the exact name.

  • A namespace must exist for this instance. You may only install once instance of the Asset Repository in a namespace. You can install the Asset Repository in a namespace also used by the Platform Navigator.

    The namespace for the Asset Repository must allow deployments that require a Security Context Constraint of type: ibm-privileged-scc. Example Security Context Constraints are included with the helm chart for each product. You can update your Security Context Constraint for an existing namespace with the following command:

    oc adm policy add-scc-to-user <scc> system:serviceaccounts:<namespace>
    
  • Create GlusterFS storage.

Deployment procedure

  1. Log in to the Platform Navigator at the URL which takes the following form: https://Ingress Proxy hostname/Ingress path. Click the menu button, then click Asset repository.

    home header bar

  2. A dialog will appear with a summary of the required pre-deployment steps. Ensure your cluster administrator has completed these steps and provided the relevant details of any created resources for the following configuration steps. Click Continue to proceed with the deployment process.
  3. Another tab will open, displaying the helm release configuration screen. Review the README information, then click Configure.
  4. Enter a unique identifier for the Helm release name.
  5. Select the Target namespace created by your cluster administrator for use with this deployment. Using the information provided by your cluster administrator, complete the configuration of the charts by entering the necessary values into the fields. Ensure you accept the license for this chart before clicking Install.

Remotes

The Asset Repository can include assets in a remote Git repository. Note assets stored in a remote repository area read-only. Click Remotes on the Asset Repository. The Remote listing page appears.

To add a new remote repository, click Add Remote. A blank configuration page appears. Complete the fields as needed.

Asset repo config

You can use an SSH key to access the remote repository. To use SSH, follow these steps.
  1. Select Use SSH authentication.
  2. Copy the key presented in the dialog box.
  3. Configure your Github repository to use the copied key. See Github help for more information about using Github.
  4. Set the Git url to the correct address. This address will begin with git@github.com.

Asset repo config

Click Create. Once the synchronization completes, you see the remote listed.

Asset remotes

The Asset Repository automatically resynchronizes with the remote repository. Click the Options icon Options icon to set the synchronization interval.

Controlling Access

Users gain access to the Asset Repository by belonging to one or more teams, which in turn have access to the repository. Click Access Control on the Asset Repository. The access settings page appears.

Asset repo access

The administrator defines users and teams through the ICP console. Click the menu icon in the Platform Navigator header and then select Platform Services.

Nav bar

See Create and manage teams for more information about adding and deleting users.