Creating a sandbox instance with WaziSandboxSystem

You can create a sandbox instance from the OpenShift® CLI or from the Red Hat® OpenShift web console.

Audience: Application developers

Prerequisites

Create a Custom Resource file in YAML format that contains the information mentioned in the Instructions on preparing for sandbox instances provisioning table to provision a sandbox instance. The detailed procedure is as follows:
  1. Create a Custom Resource file of kind: WaziSandboxSystem. If the cluster administrator does not provide a template, start with the template in Custom Resource template for WaziSandboxSystem.
  2. (Optional) Use the Custom Resource file to enable or disable as well as customize ports of the sandbox instance.

    When the sandbox instance is created, one or more Services and Routes control what ports are exposed. By default, only secured ports are exposed. The ports that are exposed map to ports on the z/OS® instance that is running in the sandbox.

    As a developer, when you connect your clients to the sandbox instance, you need to know how to connect to the expected port on z/OS based on how ports are exposed by the Routes and Services. See Using a sandbox instance for information about how to connect to the different types. Refer to client documentation to find out what ports the client expects to use. In sandbox instances, the Routes and ports are named to help make this mapping easier, for example, rse-api and tn3270-secure are used as service port names, and a Route for the rse-api port will include rse-api in its name.

    For more information about the client port mapping and other configuration requirements, see WaziSandboxSystem in Configuration reference.

Creating a sandbox instance with the OpenShift CLI

Run the oc command, for example, oc apply -f your_cr.yaml.

Or, run kubectl command, for example, kubectl apply -f your_cr.yaml.

Creating a sandbox instance with the OpenShift web console

You can create a sandbox instance by using either the Developer or Administrator perspective as follows.

Using the Developer perspective
  1. Select the Developer perspective and click +Add.
  2. Under Developer Catalog, select All services.
  3. Filter by entering the keyword IBM Wazi.
  4. Click the IBM Wazi Developer Sandbox System tile.
  5. Click Create.
  6. Select the one view to populate the parameters for the sandbox instance:
    • Form view: Provide input for the fields. Note that some fields might not be represented in this view.
    • YAML view: Recommended for full control of object creation. You can drag and drop the created WaziSandboxSystem Custom Resource to the UI or copy and past the content to the UI.
  7. Click Create.
Using the Administrator perspective (administrator privilege is required)
  1. Select the Administrator perspective.
  2. Click Operators > Installed Operators.
  3. Filter by entering the keyword IBM Wazi.
  4. Select the appropriate project, or find the instance of the Operator that you want to use to create the sandbox, and click the name.
  5. Select the Details tab, click Create instance in the IBM Wazi Sandbox System.
  6. Select the one view to populate the parameters for the sandbox instance:
    • Form view: Provide input for the fields. Note that some fields might not be represented in this view.
    • YAML view: Recommended for full control of object creation. You can drag and drop the created WaziSandboxSystem Custom Resource to the UI or copy and past the content to the UI.
  7. Click Create.

After you complete the previous steps, the Extended ADCD image volumes can be transferred to the sandbox instance automatically.

If the PersistentVolumeClaim is new, it is empty and does not contain the Extended ADCD image volumes. If the SFTP configuration is correct, the sandbox instance will attempt to copy in these volumes before it starts. Depending on the size of the files and the throughput between the sandbox instance and the SFTP server, it might take a long time before continuing.

If the application image volumes are present, either because they were already there or they were copied, the container will attempt to IPL the z/OS system.

Changing predefined credentials upon first use

The sandbox environment provides predefined credentials as described in http://dtsc.dfw.ibm.com/MVSDS/%27HTTPD2.ADCD.GLOBAL.SHTML(A24AREAD)%27#Header_09. For security considerations, password must be changed upon the first access to the sandbox environment. The sandbox instance supports multiple clients, and some clients request the password change upon the first connection, in which case the password change is integrated in the first use. However, if the client that you use does not prompt for the password change, you can connect to the sandbox instance by using the SSH port to force a password change. The SSH port is enabled by default once you successfully create your sandbox instance.

Take the sample in the Using a sandbox instance topic for example, you can find the following information for the SSH port. Obtain the IP, 172.30.155.88, and NodePort, 30459, to set up your connection. If you cannot connect to the given IP address, ask your cluster administrator how to connect to NodePort services for your cluster.
IP:                       172.30.155.88
Port:                     ssh  22/TCP
TargetPort:               22/TCP
NodePort:                 ssh  30459/TCP

Next step

Using a sandbox instance