2 Set Up Oracle Visual Builder Studio

Like other Oracle Cloud services, you must create an instance of Oracle Visual Builder Studio (VB Studio) before you can start using it. You can create only one VB Studio instance in an Oracle Cloud account.

This chapter describes how to set up VB Studio for developing applications using popular build frameworks such as Maven, Gradle, Ant, and Node.js; or uses standard infrastructure interfaces such as Docker, Kubernetes, and Terraform.

If you want to set up VB Studio to customize certain Oracle Cloud Applications through application extensions, see Set Up VB Studio to Extend Oracle Cloud Applications. If you want to set up VB Studio to develop web and mobile visual applications, and deploy them to Visual Builder instances, see Set Up VB Studio for Developing Visual Applications.

Get the Right IDCS Roles

Before you set up VB Studio, ensure that you are assigned the correct roles in Oracle Identity Cloud Service (IDCS).

You must be assigned this role: To ...
Cloud Administrator Set up Oracle Cloud Infrastructure (OCI) compartments and buckets. OCI compartments and buckets are required to set up the VB Studio build system.

If you're not assigned the role, you must belong to the OCI_Administrator group in OCI.

Identity Domain Administrator or User Administrator Add users and assign IDCS roles.

If you're not an administrator, make sure that your OCI group is assigned a policy like this:

Allow group MyGroup to inspect identity-providers in tenancy

DEVCS_APP_ENTITLEMENT_ADMINISTRATOR Create the VB Studio instance.
Compute.Compute_Operations and Storage.Storage_Administrator Create and manage VMs on OCI Compute Classic and store artifacts on OCI Object Storage Classic. The role is required only if you're an OCI Classic user.

Create the VB Studio Instance

You can create only one VB Studio instance in an Oracle Cloud account, so make sure you don't already have one before you get started.

  1. In a web browser, go to https://cloud.oracle.com.
    To view the list of supported browsers, see https://docs.oracle.com/en-us/iaas/Content/GSG/Tasks/signingin.htm#supported_browsers.
  2. In Cloud Account Name, enter your Oracle Cloud account or tenancy name and click Next.
  3. On the Single Sign-On (SSO) panel, click Continue.
  4. Enter your Oracle Cloud account credentials and click Sign In.
    The Oracle Cloud Console, also called the OCI console, opens. If you've recently created your Oracle Cloud account, wait for some time to see your services in the Oracle Cloud Console.
  5. In the upper-left corner, click Navigation Menu the Menu icon.
  6. Under More Oracle Cloud Services, select Platform Services, and then select Developer.
  7. In the Instances tab, click Create Instance.
  8. On the Create New Instance page, in Instance, enter a unique name. In Description, enter a description.
    The name helps you to identify the service instance.
  9. In Notification Email, enter your email address where you'd like to receive email notification when the instance is ready.
  10. In Region, select your home region.
    You'll find your region on the OCI console's header.
  11. Click Next.
  12. On the Service Details page, verify the entered details and click Next.
  13. On the Confirmation page, click Create.
    Expand the Instance Create and Delete History section to track the status.
Once the service instance is created, click Action the Action menu icon and then select Access Service Instance to open VB Studio's Organization page.

Here's an example:

After you create the instance:

  • You're assigned the DEVELOPER_ADMINISTRATOR IDCS role, which enables you to set up VB Studio, manage the VMs, and update the organization details. After you're assigned the role, you're also called the VB Studio's Organization Administrator.
  • You receive an email with the subject Verify your Oracle Visual Builder Studio email. Open the email and click the URL link in the email body to verify your email. This is required to receive email notifications from the service.

    After verifying the email address, you’ll receive another email with the subject Welcome to Oracle Visual Builder Studio. This email contains the VB Studio URL that you can bookmark.

  • You should configure VB Studio to connect to OCI and set up the build system.

Access VB Studio from the Oracle Cloud Home Page

If you've signed out of the Oracle Cloud or VB Studio, follow these steps to sign back in.

  1. In a web browser, go to https://cloud.oracle.com.
  2. On the Sign-In page, in Cloud Account Name, enter your Oracle Cloud account or tenancy name and click Next.
  3. On the Single Sign-On (SSO) panel, click Continue.
  4. Enter your Oracle Cloud account credentials and click Sign In.
    The Oracle Cloud Console, also called the OCI console, opens.
  5. In the upper-left corner, click Navigation Menu the Menu icon.
  6. Select OCI Cloud Services and then select Developer.
  7. In the Instances tab, click Manage this instance the Action menu icon and select Access service instance.

The VB Studio Organization page opens, which displays all the projects you're a member of, as well as your favorite projects, the projects you own, and all the shared projects in your organization. You can also set up OCI connections, virtual machines, and the properties of the organization.

Here's an example of the Organization page with some projects:

Configure VB Studio to Connect to OCI

To run builds in a VB Studio instance, you need to connect to the built-in free account, Oracle Cloud Infrastructure (OCI), or your Oracle Cloud Infrastructure Classic (OCI Classic) account.

Before you set connections, learn about how builds run in VB Studio. VB Studio uses Build Virtual Machines (VMs) to run builds of jobs your organization’s members define in VB Studio projects. Build VM templates define the operating system and the software packages installed on build VMs. A VM can run only one build at a time. If your organization's members run multiple builds at the same time, you should add multiple VMs in VB Studio. To find out more about VMs and VM templates, see What are Build VMs and Build VM Templates?.

If you're an OCI user, set up connections to OCI Compute and OCI Object Storage. VB Studio runs its builds on OCI Compute VMs, and stores build and Maven artifacts in OCI Object Storage buckets. See Connect to Your OCI Account.

If you're an OCI Classic user, set up connections to OCI Compute Classic and OCI Object Storage Classic. VB Studio runs its builds on OCI Compute Classic VMs, and stores build and Maven artifacts in OCI Object Storage Classic containers. See Connect to Your OCI Classic Account.

If you're not an OCI or OCI Classic user, you can use the VB Studio's built-in free account and run builds on the built-in free VM, but with some limitations. See VB Studio's Built-In Free Account.

What are Build VMs and Build VM Templates?

Before you learn about Build VMs and VM templates, you benefit from some information about OCI Compute Virtual Machine (VM) compute instances, OCI regions, VM shapes, OCI Virtual Cloud Network (VCN), and subnets.

Build VM Templates

A Build VM template defines the operating system and software packages installed on a Build VM. You must create a VM template before you add VMs. VB Studio offers some VM templates out-of-the-box that your organization's users can use. You can create more VM templates if the default VM templates don’t meet your requirement. See Create and Manage Build VM Templates.

When you create a VM template, VB Studio adds the operating system, Java, and some required software packages to it. These default software packages are called Required Build VM Components. More software packages are available in the VB Studio Software Catalog. See Software for Build VM Templates.

Some key points to remember about VM templates:

  • VM templates don't consume storage space or increase your cost. You can create as many VM templates as you require.
  • You can't add a software package or its version to a VM template that's not available in the VB Studio Software Catalog.
  • In the Software Catalog, some software packages have multiple versions. You can add only one version to the VM template. However, you can add multiple versions of Java to a VM template.
  • Some software packages, such as Fn and Oracle Jet, require other software packages in the same VM template. When you add such software packages, VB Studio prompts you to add the dependent software packages.
  • Don't add unnecessary software packages to a VM template. More software packages you add to a VM template, more storage space its VMs consume when they run builds.

Build VMs

A Build VM is an OCI or OCI Classic VM compute instance dedicated to run builds of jobs your organization’s members define in VB Studio projects. A VM is always associated with a VM template. When your organization's members create jobs, they simply associate the appropriate VM template with the job. When the job's build triggers, VB Studio runs the build on a VM that's associated with the VM template.

A VM starts automatically when a build of a job that references its VM template triggers, and changes its state accordingly. Remember, a VM costs you only when it is active, runs a build, or preparing itself to run a build.

This table describes the different states of a VM:

State What does it mean? Does it cost?
Pending After you add a VM, it is in this state until it runs a build.

When a VM starts from this state, it takes some time to install the operating system and software packages.

No
Starting VM is starting.

If the VM starts from the Pending state, VB Studio installs the operating system and software packages on the VM's assigned boot volume. This takes time.

If the VM starts from the Stopped state, VB Studio uses software packages and the operating system from the previous run's saved boot volume.

Yes
Available Operating system and software packages are installed, and the VM is ready to run a build. Yes
In Use VM is running a build.

After the running build is complete, the VM returns to the Available state.

Yes
Stopping VM is shutting down.

Before shutting the VM down, VB Studio saves the operating system and software packages to the VM's assigned boot volume.

Yes
Stopped VM has shut down. No
Error There's a hardware or a software issue on the VM. Check the VM's log to find more about the cause. No
Destroying VM is being deleted. No

Some key points to remember about VMs:

  • To add a VM, you must specify the VM template, choose an OCI region from the connected OCI account's subscribed regions, specify the VM's shape, and select the VCN (optional).
  • Your OCI account may have some Compute instance limits set. When you add a VM, VB Studio looks into the specified OCI region's Availability Domains, finds available OCPUs of the specified shape, calculates the number of Compute instances, and displays the number of Compute VM instances you can add from your OCI account's set limit.

    Here's an example of the VB Studio's Add Build VM dialog box that displays the number of VMs you can add of the VM.Standard.E2.1 shape:

    Add Build VM dialog box with a message about number of VMs available
  • When you add a VM, it is added in the Pending state and doesn't cost you. You can add more VMs than the number of available Compute VM instances.

    Remember, VB Studio creates a Compute VM instance when a VM starts, not when you add it.

  • You can add standard and legacy VM shapes of these series:
    • VM.Standard1
    • VM.Standard2
    • VM.Standard.E2
    • VM.Standard.B1

    For more details about the above shapes, see Standard shapes and Legacy shapes.

  • A VM can run one build at a time.
  • When a job's build runs, if VB Studio finds multiple VMs allocated for the job's VM template, it runs the build on any one of them. You can't choose or specify which VM to use for the build.
  • If you expect your organization's members to run parallel builds of jobs that refer to a common VM template, add multiple VMs for that VM template. If you're not sure, you can start with one VM and add more VMs later.
  • While adding multiple VMs that reference a common VM template:
    • Add all VMs in the same VCN. If you add VMs of a common VM template in different VCNs (such as some VMs in the default VCN and other VMs in a custom VCN), your builds might behave unpredictably.
    • Add all VMs of the same shape. If you add VMs of different shapes (such as some VMs of the VM.Standard1.1 shape and some of the VM.Standard2.8 shape), your builds may run slow or fast depending on the VM it runs on.
  • After a build is complete, a VM continues to be in the Available state and waits for some time for any queued builds. This wait time is called sleep timeout. If no builds run on the VM in this duration, VB Studio automatically stops the VM.
  • More VMs you have running at a specific time, the higher the cost. To minimize the higher cost, configure the sleep timeout to stop inactive VMs after some time. The sleep timeout setting applies to all VMs of your organization.

What happens when a build runs?

When a job's build runs:
  1. VB Studio checks the job's VM template and then finds a VM that's allocated to it.

    If no VMs are found, it fails the build. If one or more VMs are found, it selects the VM to run the build in this order:

    • If a VM is in the Available state, VB Studio immediately runs a build on it.
    • If no VMs are in the Available state, VB Studio starts a Stopped VM, installs the operating system and the template's software packages from the saved boot volume, and then runs the build on it.
    • If no VMs are in the Available or the Stopped state, VB Studio starts a Pending VM, installs the operating system and the template's software packages, and then runs the build on it.
    • If all VMs are running builds, VB Studio waits for a VM to complete its build, and then runs a build on it.

    VB Studio selects any VM if multiple VMs are found in the same state. You can't choose or specify which VM to use for the build.

  2. VB Studio checks the job's configuration and runs the commands in the specified order.
  3. After the build is complete, VB Studio copies any generated artifacts to the configured OCI Object Storage bucket or the OCI Object Storage Classic container.
  4. The VM waits for some time for any queued builds. If no builds run during the wait time period, the VM stops.

    Before stopping the VM, VB Studio saves the operating system and software packages to the VM's assigned boot volume.

VB Studio's Built-In Free Account

In some OCI regions and data centers, the VB Studio instance is available pre-configured with a built-in free account. Full rollout to all OCI regions and data centers is planned in a future release of VB Studio.

The built-in free account provides a built-in free VM of a fixed shape and a VM template with a minimal set of software. You can use the built-in free VM to build VB Studio projects when you extend Oracle Cloud Applications using app extensions or develop Visual Builder web and mobile applications. The built-in free VM runs on VB Studio's default VCN. See Use VB Studio's Default VCN to learn about it.

A VM can run only one build at a time. The more VMs you have available, more builds your organization's members can run at the same time. As the built-in free account offers only one VM, your VB Studio organization members can run only one build at a time. If members trigger multiple builds while a build is already running, they must wait until the build running on the VM is complete. The VM then runs the queued builds on a first-come-first served basis.

The default VM template, called System Default OL7 for Visual Builder, includes the necessary software to run app extension and visual application builds. You can't change the default VM template's configuration. This table lists the software defined in System Default OL7 for Visual Builder:

Software Version
Oracle Linux operating system 7.x
Node.js 10.x
Oracle Java SE 1.8.x
Ant 1.9.6
C++ Compiler (cpp/gcc) 4.8.x
Firefox 78.4.x (or later)
Git 1.8.x (or later)
Jq 1.5.x (or later)
JUnit 4 4.11 (or later)
Maven 3.6.x
Python2 (including Virtualenv) 2.7.x
Ruby 2.0.0p648
Xvfb 1.15.x

If you want to add more VMs to reduce the wait time for your organization's members or create custom VM templates, or use advanced features for VMs (such as use your own VCN or use a different VM shape), you should configure VB Studio to connect to your own OCI or OCI Classic account.

This table summarizes the differences between the built-in free account and your OCI or OCI Classic account:

Features Built-In Free Account Your OCI/OCI Classic Account What it means?
Number of VMs 1 Unlimited If VB Studio is connected to your OCI or OCI Classic account, you can add multiple VMs to reduce the build wait time for your organization's members.
Number of VM templates 1 Unlimited If VB Studio is connected to your OCI or OCI Classic account, you can create as many VM templates you want with custom software such as Docker, Kubernetes, or SQLcl. See Software Packages in the Software Catalog for the complete list of software available for VM templates.
Storage for build artifacts 50 GB Unlimited

When your organization's members run builds, VB Studio saves the generated build artifacts in its configured storage space. If you're using the built-in free account, the build artifacts are stored in a limited storage space. If you run out of storage space, builds that generate artifacts fail. To continue using the built-in free account, either remove some artifacts from the storage, or switch to an OCI or OCI Classic account. You can't increase the storage space allocated to your built-in free account.

If VB Studio is connected to your OCI or OCI Classic account, the artifacts are stored in OCI Object Storage buckets or OCI Classic containers. You can always increase the storage space to store more artifacts.
VM shape Fixed shape Custom shapes, including shapes offered by OCI If VB Studio is connected to your OCI or OCI Classic account, you can choose any VM shape offered by OCI. To learn more about shapes, see VM Shapes.
VCN VB Studio's default VCN VB Studio's default VCN or your custom VCN If VB Studio is connected to your OCI or OCI Classic account, you can add VMs in a custom VCN to access Oracle Cloud services that are running in the same VCN.
Wait time 5 minutes (fixed) Custom wait time After running a build, a VM waits for some time to run any queued builds. If no builds run in the wait time period, the VM stops. If a build triggers after a VM has stopped, the VM takes some time to start before it could run the build.

If VB Studio is connected to your OCI or OCI Classic account, you can customize the wait time for your VMs.

Maven and NPM repositories Not available Available If VB Studio is connected to your OCI or OCI Classic account, your organization's members can use their projects' hosted Maven and NPM repositories to upload custom dependencies and binary files.

Connect to Your OCI Account

Before you configure VB Studio to connect to your OCI account, set up the OCI account to host and manage necessary resources, such as VMs for your builds and storage buckets for your project data.

To set up the OCI account, open the OCI console and create a compartment, a group and a user to access the compartment, and a policy that defines access to the compartment.

You can use the root compartment and the tenancy user that was created when the OCI account was created, but it's recommended to create a dedicated compartment to host VB Studio resources. This allows you to organize VB Studio resources better because they aren't mixed with the other resources of your tenancy. You can also restrict users and control read-write access to the compartment without affecting other resources. To learn more about compartments, see Understanding Compartments.

Note:

If you use Oracle Cloud OS Management Service (OSMS), don't configure VB Studio to use the OSMS compartment, or a compartment with an OSMS policy. OSMS compartments aren't compatible with VB Studio VMs.

To set up the OCI account, create resources as described in Set Up the OCI Account. After creating the resources, get their details as described in Get the Required OCI Input Values because you'll need them to Set Up the OCI Connection in VB Studio.

If you don't have authorization to create and manage OCI resources, ask some one who can create the resources and share their details.

Set Up the OCI Account
  1. On the OCI console, in the upper-left corner, click Navigation Menu the Menu icon.
  2. Under Governance and Administration, select Identity, and then select Compartments.
  3. On the Compartments page, create a compartment to host VB Studio resources.
    1. To create the compartment in the tenancy (root compartment), click Create Compartment.
    2. In the Create Compartment dialog box, fill in the fields and click Create Compartment.
    To learn more about compartments, see Managing Compartments.
  4. Create a user to access the VB Studio compartment.
    1. In the left navigation menu, under Governance and Administration, click Identity, and then click Users.
    2. Click Create User.
    3. Select the IAM user type and click Next.
    4. In the Create User dialog box, fill in the fields and click Create.
    To learn more about OCI users, see Managing Users.
  5. On your computer, generate a private-public key pair in the PEM format.
    To find out how to generate a private-public key pair in the PEM format, see How to Generate an API Signing Key.

    Here's an example of private-public key files on a Windows computer:

  6. Upload the public key to the user's details page.
    1. Open the public key file in a text editor and copy its contents.
    2. In the left navigation menu of the OCI console, under Governance and Administration, click Identity, and then click Users.
    3. Click the user's name created in Step 4.
    4. Under Resources, click API Keys.
    5. Click Add Public Key.
    6. In the Add Public Key dialog box, paste the contents of the public key file, then click Add.
    To learn more about uploading keys, see How to Upload the Public Key.
  7. On the Groups page, create a group for the user who can access the VB Studio compartment and add the user to the group.
    1. In the left navigation menu, under Governance and Administration, go to Identity, and click Groups.
    2. Click Create Group.
    3. In the Create Group dialog box, fill in the fields and click Create.
    4. On the Groups page, click the group's name.
    5. On the Group Details page, click Add User to Group.
    6. In the Add User to Group dialog box, select the user created in Step 4 and click Add.
    To learn more about groups, see Managing Groups.
  8. In the root compartment, not the VB Studio compartment, create a policy to allow the group created in step 6 to access the VB Studio compartment.
    1. In the navigation menu, under Governance and Administration, click Identity, and then click Policies.
    2. On the left side of the Policies page, from the Compartment list, select the root compartment.
    3. Click Create Policy.
    4. In Name and Description, enter a unique name and a description.
    5. In Compartment, select the root compartment.
    6. In Policy Builder, click Customize (Advanced) and add these statements:
      • allow group <group-name> to manage all-resources in compartment <compartment-name>

        This grants all permissions to the VB Studio group users to manage all resources within the VB Studio compartment.

      • allow group <group-name> to read all-resources in tenancy

        This grants read permissions to the VB Studio group so that its users can read—but not use, create or modify—all resources inside and outside the VB Studio compartment. The group users can't use, create, or modify the resources.

      Here's an example:

    7. Click Create.
    To learn more about policies, see Managing Policies.
Get the Required OCI Input Values

Every Oracle Cloud Infrastructure resource has an Oracle-assigned unique ID called an Oracle Cloud Identifier (OCID).

To connect to OCI, you need the account's tenancy OCID, home region, the OCID of the compartment that hosts VB Studio resources, and the OCID and the fingerprint of the user who can access the VB Studio compartment. To connect to OCI Object Storage, you need the Storage namespace. You can get these values from the OCI Console pages.

This table describes how to get the OCI input values required for the connection.

To get these values ... Do this:
Tenancy OCID, Home Region, and Storage Namespace Open the OCI console. In the navigation menu, under Governance and Administration, select Administration, and then select Tenancy Details.

The Tenancy Information tab displays the tenancy OCID in OCID, the home region in Home Region, and the storage namespace in Object Storage Namespace.

Here's an example:

User OCID and Fingerprint Open the OCI console. In the navigation menu, under Governance and Administration, select Identity, and then select Users. On the Users page, click the user's name.

The User Information tab displays the user OCID in OCID. Click the Copy link to copy it to the clipboard.

Here's an example of vbstudio.user:

To get the fingerprint of the public key associated with your OCI account, scroll down to Resources and select API Keys, and copy the fingerprint value.

Compartment OCID Open the OCI console. In the navigation menu, under Governance and Administration, select Identity, and then select Compartments. On the Compartments page, click the compartment's name.

The Compartment Information tab displays the compartment's OCID in OCID. Click the Copy link to copy the compartment's OCID to the clipboard.

Here's an example:

Set Up the OCI Connection in VB Studio

To connect to OCI, get the VB Studio compartment's details, user details, and the required OCID values. Then, create an OCI connection from VB Studio. If you're not the OCI administrator, get the details from the OCI administrator.

  1. In the navigation menu, click Organization Organization.
  2. Click the OCI Account tab.
  3. Click Connect.
  4. In Account Type, select OCI.
  5. In Tenancy OCID, enter the tenancy's OCID copied from the Tenancy Details page.
  6. In User OCID, enter the OCID of the user who can access the VB Studio compartment.
  7. In Home Region, select the home region of the OCI account.
  8. In Private Key, enter the user's private key who can access the VB Studio compartment.
    The private key file was generated and saved on your computer when you created the private-public key pair in the PEM format. See Step 5 in Set Up the OCI Account.

    Make sure that the private key you enter contains the -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY----- markers.

  9. In Passphrase, enter the passphrase used to encrypt the private key. If no passphrase was used, leave the field empty.
  10. When you enter a private key and a passphrase, the Fingerprint field is automatically populated. Ensure that the automatically populated fingerprint value matches the fingerprint value of your private-public key pair. If it doesn't, update it to enter the correct value.
  11. In Compartment OCID, enter the compartment's OCID copied from the Compartments page.
  12. In Storage Namespace, enter the storage namespace copied from the Tenancy Details page.
  13. To agree to terms and conditions, select the terms and conditions check box.
  14. To validate the connection details, click Validate.
  15. After validating the connection details, click Save.
Here's an example of an OCI Account tab filled with required OCI details.

Connect to Your OCI Classic Account

To connect to OCI Classic, you need the credentials of a user with the Compute.Compute_Operations and Storage.Storage_Administrator identity domain roles along with the service ID and Authorization URL of OCI Object Storage Classic.

The Compute.Compute_Operations role enables you to create, update, and delete VMs on OCI Compute Classic. The Storage.Storage_Administrator role enables you to store artifacts on OCI Object Storage Classic.

Before you create the OCI Compute Classic connection, you must check the Compute_Operations Role: Terms of Use and get the Service ID and the authorization URL of OCI Object Storage Classic.

Get OCI Classic Input Values
  1. Open the Oracle Cloud Dashboard.
  2. In the Storage Classic tile, click Actionthe Action menu icon and select View Details.

    If the Storage Classic tile isn’t visible, click Customize Dashboard. Under Infrastructure, find Storage Classic, click Show, and then close the Customize Dashboard window.

  3. On the Service Details page, in the Additional Information section of the Overview tab, note the values of the Auth V1 Endpoint URL and the last part of the REST Endpoint URL.

    If you’re using an Oracle Cloud traditional account, the fields shown in this graphic might differ from the fields on your Service Details page.

    Here's an example:

    Description of storage_cloud_console.png follows
    Description of the illustration storage_cloud_console.png

  4. Return to the Oracle Cloud Dashboard.
  5. In the Compute Classic tile, click Actionthe Action menu icon and select View Details.
  6. On the Service Details page, in the Additional Information section of the Overview tab, note the values of Service Instance ID and REST Endpoint.

    Here's an example:

    Compute Classic console

Create an OCI Classic Connection from VB Studio

After you have the required values, create an OCI Classic connection from VB Studio.

  1. Sign in to VB Studio.
  2. In the navigation menu, click Organization Organization.
  3. Click the OCI Account tab.
  4. To create a connection, click Connect. To edit the connection details, click Edit.
  5. In Account Type, select OCI Classic.
  6. In the OCI Object Storage Classic section, fill in the required details.
    1. In Service ID, enter the value copied from the last part of the REST Endpoint URL field of the Service Details page.
      For example, if the value of the REST Endpoint URL is https://demo12345678.storage.oraclecloud.com/v1/Storage-demo12345678, then enter Storage-demo12345678.
    2. In Username and Password, enter the credentials of the user assigned the Storage.Storage_Administrator identity domain role.
    3. In Authorization URL, enter the URL copied from the Auth V1 Endpoint field of the Service Details page.
      Example: http://storagetria01234-usoracletria12345.storage.oraclecloud.com/auth/v1.0.
    4. Click Validate.
  7. In the OCI Compute Classic section, fill in the required details.
    1. In Username and Password, enter the credentials of the user who’s assigned the Compute.Compute_Operations identity domain role.
    2. In Service Instance ID, enter the OCI Compute Classic service instance's ID.
    3. In REST Endpoint URL, enter the REST URL.
    4. To agree to terms and conditions, select the terms and conditions check box.
    5. Click Validate.
  8. Click Save.
Compute_Operations Role: Terms of Use

Here are some special legal terms and guidance that apply to the usage of the Compute_Operations role for VB Studio.

In addition to these VB Studio terms, you should follow security best practices in maintaining the security of the username and password.

  • You must create a dedicated username and password for use by VB Studio. When creating a username, avoid including personal names or personal information (like birthdays). Your password should always be complex and impossible to guess.

  • You understand that a user with the Compute_Operations role can view, create, update and delete OCI Compute Classic resources such as VM instances, storage volumes, security rules, and security IP lists. Your failure to maintain security best practices to secure the username and password of the user with the Compute_Operations role may create a high risk for you and your organization.

  • You should assign the Compute_Operations role privileges only to the username created for VB Studio.

  • Notwithstanding VB Studio terms, you acknowledge that Oracle isn’t responsible or liable for any action you take in accessing or creating access to the VB Studio or OCI Compute Classic.

Change Your OCI Account

If you are using the built-in free account, or your own OCI or OCI Classic account, you can switch to another OCI account any time and use the new account's resources.

When you switch to another OCI account:

  • Your current OCI account's VM templates and their metadata migrate to the new OCI account. For example, If you have 10 VM templates in your current OCI account, VB Studio creates the same number of templates with the same software in the new OCI account.
  • Your current OCI account's VMs and their metadata migrate to the new OCI account. For example, if you have 234 VMs in your current OCI account, VB Studio creates the same number of VMs of the same shape, VCN, and VM templates in the new OCI account.
  • Data stored in your current OCI account's Object Storage buckets don't migrate to the new account. The data may include build artifacts, Maven artifacts, NPM artifacts, and exported project data.

If you switch to the built-in free account, you'll lose access to data in Object Storage, and your current account's VM templates and VMs. Instead, you'll get access to only one built-in free VM and the default VM template.

Switch to Another OCI Account
To switch to another OCI account, get the required OCI input values and follow these steps:
  1. In the navigation menu, click Organization Organization.
  2. Click the OCI Account tab.
  3. Click Edit.
  4. Enter the OCID details of the new OCI account and click Validate.
  5. After successful validation, click Save.
After you save, VM templates and VMs of your old OCI account migrate to the new OCI account.
Switch to an OCI Account From the Built-In Free Account
To switch to an OCI account, get the required OCI input values and follow these steps:
  1. In the navigation menu, click Organization Organization.
  2. Click the OCI Account tab.
  3. Click Connect OCI Account.
  4. In Account Type, select OCI.
  5. Enter the OCID details of the new OCI account as described in Set Up the OCI Connection in VB Studio and click Validate.
  6. After successful validation, click Save.
After you save, the VM template and the built-in free VM of your built-in free account migrate to the OCI account.
Switch to the Built-In Free Account From an OCI Account
If you switch to the built-in free account, VM templates and VMs of your current OCI account are deleted and you get access to only one built-in free VM with fixed software in the default VM template. You can't add more VMs or edit the VM template's software.
  1. In the navigation menu, click Organization Organization.
  2. Click the OCI Account tab.
  3. Click Edit.
  4. Deselect the terms and conditions check box, and click Remove Account.
  5. In the Confirm Removal of OCI Account dialog box, click Remove Account.
After you remove your OCI account, you're automatically connected to the built-in free account.

Set Up the Build System

The build system in VB Studio enables your organization's members to create jobs to build, test, and deploy apps. The builds run on Build Virtual Machines (VMs).

Before they create jobs, follow these steps to you must set up the build system:

  1. If you're new to VB Studio, learn about Build VMs and Build VM templates.
  2. If you haven't, configure VB Studio to connect to the built-in OCI account, or your OCI or OCI Classic account.
  3. (Optional) Configure your VCN to run Build VMs.
  4. Create Build VM templates.

    You can't create a Build VM template if you're using the built-in free account.

  5. Add Build VMs.

    You can create only one VM if you're using the built-in free account.

Build VMs in Virtual Cloud Network

A Build VM runs in a Virtual Cloud Network (VCN). You can run Build VMs in the VB Studio's default VCN, or in your VCN.

Note:

You can't create or manage VCN of Build VMs if VB Studio is connected to the built-in free account. If you want to use your own VCN, configure VB Studio to connect to your OCI account.

If you don't have a VCN or want to use the default option without any additional configuration, use the VB Studio default VCN. If you want Build VMs to access services that are running in your VCN, then you should run Build VMs in your VCN.

Use VB Studio's Default VCN

If you don't have a VCN to run Build VMs, use VB Studio's default VCN. It is automatically created for you when the first Build VM that uses it starts.

VB Studio's default VCN, called vbs-executor-vcn, resides in the compartment you created and configured in Connect to Your OCI Account. When a Build VM that uses the default VCN starts, VB Studio checks its OCI compartment for the default VCN. If it doesn't exist, VB Studio creates a VCN called vbs-executor-vcn with CIDR block 10.0.0.0/16. If the VCN exists, VB Studio uses it to run your Build VMs.

When VB Studio creates the default VCN, it also creates these components and adds them to the VCN:

  • An Internet Gateway
  • A Route Table that uses the Internet Gateway as the routing rule
  • A Security Rule with these rules:
    • Ingress: Allow TCP traffic on destination port 22 (SSH), 9003 (Executor agent debug), 9005 (VM agent debug), 9082 (Executor agent), and 9085 (VM agent) from source 0.0.0.0/0 and any source port.
    • Egress: To any destination from any protocol
  • Three subnets, one for each availability domain. Their CIDR is set to 10.0.0.0/24, 10.0.1.0/24, and 10.0.2.0/24.

As soon as the default VCN is available, you have full control over it and can modify it. You can add private subnets for your private services, add more public subnets or delete the existing subnets, modify security lists, and add or remove other components.

Note:

  • If you modify the default VCN, make sure that at least one public subnet is available in the VCN. If there are no public subnets, Build VMs in the default VCN won't run and your builds will fail.
  • The default VCN is created once and continues to stay until it is deleted manually.
  • If your organization's members configure jobs that access services in the private or public subnets of the VCN, ask them to configure their jobs to access the services using private IPs or Fully Qualified Domain Name (FQDN).
Run Build VMs in Your VCN

If you run Oracle Cloud services in your VCN, you should configure your VCN to run VB Studio Build VMs so your services and Build VMs are in the same VCN. This lets Build VMs access your Oracle Cloud services easily without any complex networking configuration.

Before you configure your VCN, make a note of these:

  • In your VCN, create a public subnet or configure an existing public subnet to allow inbound access from and outbound access to VB Studio.
  • When you're creating or configuring a public subnet, make sure it is regional.
  • Instead of modifying an existing security list's security rules, you should create a new security list for the public subnet.

    For the public subnet, create a security list and add ingress rules from source CIDR 0.0.0.0/0 for VB Studio ports 22 (SSH), 9082 (Executor Agent), and 9085 (VM Agent). This is required to allow VB Studio access the Build VMs in your VCN.

  • If your VCN isn't in the same compartment that VB Studio is in, make sure that the user whose OCID you've specified in Set Up the OCI Connection in VB Studio is assigned the use virtual-network-family policy for the VCN's compartment. This is required for networking permissions and builds to run in your VCN. This statement assigns the policy to the user's group:

    allow group <group-name> to use virtual-network-family in compartment <vcn-compartment-name>

    Here's an example of the use virtual-network-family policy added to the policies you created in Set Up the OCI Account.

    VBStudio policies in OCI
  • Make sure that your VCN has a route table with a rule that allows Internet access.
  • To allow Build VMs access your private subnet's services and resources, configure the private subnet's security rules to allow incoming traffic from the public subnet used by Build VMs.
  • After adding Build VMs to your VCN, ask your organization's members to configure their build jobs to use the private IP addresses or the Fully Qualified Domain Name (FQDN) of services that are running in the VCN.

    Tell them not to use public IP addresses, because when Build VMs are in the same VCN as the service, public IP addresses will route the traffic outside the VCN, causing builds to fail.

Build VMs run in a VCN's public subnet. This table describes what you need to do if you have a VCN.

If ... Then :
You have a VCN without a public subnet
  1. Create and Configure a Public Subnet in Your VCN.

    You'll also configure the subnet's security list to allow inbound access from and outbound access to VB Studio.

  2. To allow Build VMs access a service running in your private subnet, configure the private subnet's security list. See Allow Build VMs to Access Your Private VCN Resources.
  3. Add and Manage Build VMs in your VCN.
You have a VCN with a public subnet
  1. In your VCN, create a security list with ingress rules and egress rules, as described in steps 6-11 of Create and Configure a Public Subnet in Your VCN.
  2. Open your public subnet's details page and add the security list. See 13 of Create and Configure a Public Subnet in Your VCN.
  3. To allow Build VMs access services running in your private subnet, configure the private subnet's security list. See Allow Build VMs to Access Your Private VCN Resources.
  4. Add and Manage Build VMs in your VCN.
You don't have a VCN and want to create one
  1. Use the VCN wizard to create a VCN with a public subnet and an internet gateway. See Virtual Networking Quickstart.
  2. Create and Configure a Public Subnet in Your VCN.

    You'll also configure the subnet's security list to allow inbound access from and outbound access to VB Studio.

  3. To allow Build VMs access services running in your private subnet, configure the private subnet's security list. See Allow Build VMs to Access Your Private VCN Resources.
  4. Add and Manage Build VMs in your VCN.
Create and Configure a Public Subnet in Your VCN

Before you can run Build VMs in your VCN, you must first create a public subnet in your VCN with security rules that allow inbound access from and outbound access to VB Studio.

  1. Sign in to Oracle Cloud Console.
  2. On the OCI console, in the upper-left corner, click Navigation Menu the Menu icon.
  3. Under Core Infrastructure, select Networking, and then select Virtual Cloud Networks.
  4. Under List Scope, select the compartment.
  5. From the VCNs list, click the VCN's name.
  6. Under Resources, click Security Lists, and then click Create Security List.
  7. In Name, enter a name for the security list.
  8. In Create in Compartment, ensure that the correct compartment is selected.
  9. In Allow Rules for Ingress, click + Additional Ingress Rule and follow these steps:
    1. In Source Type, select CIDR.
    2. In Source CIDR, enter 0.0.0.0/0.
    3. In Destination Port Range, enter 9082.
    4. (Optional) In Description, add a description.
    5. Click + Additional Ingress Rule and repeat steps from 9.a to 9.d to add ports 9085 and 22.
  10. In Allow Rules for Egress, click + Additional Egress Rule and follow these steps:
    1. In Source Type, select CIDR.
    2. In Source CIDR, enter 0.0.0.0/0.
    3. In IP Protocol, select All Protocols.
    4. (Optional) In Description, add a description.
  11. Click Create Security List.
    After creating the security list, click its name to verify the ingress and egress rules you added.

    Here's an example of ingress rules:

    Here's an example of the egress rule:

  12. Under Resources, select Subnets and follow these steps to create a public subnet:
    If you want to edit an existing public subnet, jump to the next step.
    1. Click Create Subnet.
    2. In Name, enter the subnet's name.
    3. In Subnet Type, make sure that Regional is selected.
    4. In CIDR Block, enter the subnet's CIDR block.
      Don't set it to 172.17.0.0/16 as it's the default subnet allocated to Docker.
    5. In Route Table, select the VCN's route table.
    6. In Subnet Access, make sure that Public Subnet is selected.
    7. In DHCP Options, select the VCN's DHCP options.
    8. In Security List, select the security list you created in Step 6.
    9. Fill in the other fields.
    10. Click Create Subnet.
  13. If you want to edit an existing subnet, follow these steps:
    1. Under Resources, select Subnets and click the public subnet's name.
    2. Click Add Security List.
    3. In the Add Security List dialog box, in Security List, select the security list you created in Step 6.
    4. Click Add Security List.
That's it. After creating or editing the public subnet, your Build VMs can now run in your VCN.
Allow Build VMs to Access Your Private VCN Resources

After adding a public subnet in your VCN, if you want Build VMs to access the resources and services (such as Java Cloud Service or a VM-based Database) running in the VCN's private subnet, configure the private subnet's security rules to allow incoming traffic from the public subnet used by Build VMs.

For example, to allow Build VMs access Java Cloud Service running in a private subnet, configure the subnet's security list to add the Build VMs CIDR ranges to the Ingress rule associated with the JCS Admin port.

  1. Sign in to Oracle Cloud Console.
  2. On the OCI console, in the upper-left corner, click Navigation Menu the Menu icon.
  3. Under Core Infrastructure, select Networking, and then select Virtual Cloud Networks.
  4. On the Virtual Cloud Networks page, click the VCN.
  5. Under Resources, click Security Lists, and then click the private subnet's security list.
  6. Click Add Ingress Rules.
    If you want to modify an existing rule, click the Actions icon (three dots), and then select Edit.
  7. In Source Type, select CIDR.
  8. In Source CIDR, enter the Build VMs public subnet's CIDR range.
  9. In Destination Port Range, enter the service's port number.
  10. (Optional) In Description, add a description.
    Here's an example of Java Cloud Service port 7002 with a source CIDR of 10.0.4.0/24:
  11. Click Add Ingress Rules.
  12. If required, repeat steps from 6 to 11 for each service's port.

Create and Manage Build VM Templates

You can create and manage Build VM templates from the Virtual Machine Templates tab of the Organization Administration page.

Note:

You can't create or manage Build VM templates if VB Studio is connected to the built-in free account. If you want to use software that aren't available in the default Build VM templates, configure VB Studio to connect to your OCI or OCI Classic account.

VB Studio offers these VM templates out-of-the-box that your organization's users can use. You can't modify or delete these VM templates.

VM template Description
System Default OL7 for Visual Builder Use this template to package and deploy application extensions and visual applications. The template defines these software packages on Oracle Linux 7:
  • Node.js 10
  • Default software packages
System Default OL7 Use this template for build jobs that use the default software packages on Oracle Linux 7.
System Default OL6 Use this template for build jobs that use the default software packages on Oracle Linux 6.

If the above VM templates don't meet your requirements, you can create as many VM templates as required. VM templates don't consume storage space or increase your cost.

Here's an example of some custom VM templates along with the system default VM templates.

VB Studio custom VM templates

This table describes the actions you can perform to create and manage VM templates.

Action How To

Create a custom VM template

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines Templates tab.

  3. Click + Create Template.

  4. In the New VM Template dialog box, enter a name and description of the VM template. In Platform, select the operating system to run on the VM.

  5. Click Create.

  6. Click Configure Software.

  7. If necessary, in Filter Software Packages, enter the search term and click the Search icon.

    To see the latest version of the software package, select the Show latest versions only check box. This is helpful if multiple versions of the same software are available in the catalog.

  8. In the Software Catalog, click Add Add.

    If a software package is dependent on another software package, a message informs you about the dependencies that must be added along to use the software.

  9. Click Done.

Configure a VM template’s software
  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines Templates tab.

  3. Select the template and click Configure Software.

  4. If necessary, in Filter Software Packages, enter the search term and click the Search icon.

    To see the latest version of the software package, select the Show latest versions only check box. This is helpful if multiple versions of the same software are available in the catalog.

  5. In the Software Catalog, click Add Add.

    If a software package is dependent on another software package, a message informs you about the dependencies that must be added along to use the software.

  6. Click Done.

Edit a VM template's name or description
  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines Templates tab.

  3. Select the template and click Edit.

  4. In the Edit VM Template dialog box, update the name or description.
  5. Click Save.

Delete a VM template

When you delete a VM template, its VMs are deleted too.

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines Templates tab.

  3. Select the template and click Delete Delete.

  4. In the Delete VM dialog box, click Yes to confirm.

Add and Manage Build VMs

You can create and manage Build VMs from the Virtual Machines tab of the Organization Administration page.

Note:

You can't create or manage VMs if VB Studio is connected to the built-in free account. If you want to add more than one VM, configure VB Studio to connect to your OCI or OCI Classic account.

A VM can run one build at a time. If you expect your organization's members to run builds in parallel of jobs that refer a common VM template, you should add multiple VMs for that VM template. VB Studio can run up to 99 builds in parallel using the same VM template. Note that the more VMs you have running at a specific time, the higher the cost. To minimize the higher cost, use the Sleep Timeout setting to automatically shut down inactive VMs.

Here's an example of multiple VMs using a common VM template.

Multiple VMs using a common VM template

This table describes the actions you can perform to manage VMs.

Action How To
Add the built-in free VM in the built-in free account

You can add and use the built-in free VM only if your VB Studio instance is connected to the built-in free account.

  1. In the navigation menu, click Organization Organization
  2. Click the Virtual Machines tab.
  3. Click Create Free VM.

VB Studio creates the built-in free VM that uses the System Default OL7 for Visual Builder template. You can't change the VM's template.

The new VM is in the Pending state until you manually start it or trigger a job's build that references the associated VM template.

Find VMs of a VM template
  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. From the Sort By list, select Template to sort the VMs in the Build VMs tab.
  4. Scroll down and search the list for the template's name.

You might find multiple VMs that use the same VM template.

Add a VM in the VB Studio's default VCN

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. Find VMs of the VM template you want to use.

    If there are no VMs of the VM template, jump to Step 4.

    If you find one or more VMs that use the VM template, get each VM's VCN name. If the VCN's name isn't vbs-executor-vcn, click the Actions Menu icon and select Delete to delete the VM. You should not add VMs to different VCNs that use the same VM template.

  4. In the Build VMs tab, click + Create VM.

  5. In the Add Build VM dialog box, in Quantity, specify the number of VMs you want to create.

    To minimize build execution delays, set the number to the number of jobs that you expect to run in parallel using the template you'll specify in VM Template. If you're not sure, start with one VM. You can add more VMs later, based on your actual usage.

  6. In VM Template, select the Build VM template.
  7. In Region, select the region that's closer to you geographically.

    The drop-down list displays regions your OCI account is subscribed to.

  8. In Shape, select the VM's shape.

    Wait for a few seconds. VB Studio calculates the number of Compute VM instances that can be created of the selected shape and displays it in the dialog box. If the required number of VM instances aren't available, choose another shape.

    Here's an example:

    Add Build VM dialog box with a message about number of VMs available
  9. In VCN Selection, select Default.
  10. Click Add.

The new VM is in the Pending state until you manually start it or trigger a job's build that references the associated VM template.

Add a Build VM in your custom VCN Before you add a VM, make sure you've added a public subnet in your VCN. See Create and Configure a Public Subnet in Your VCN.
  1. In the navigation menu, click Organization Organization.

  2. In the Virtual Machine Templates tab, make sure that the Build VM template has the correct software.
  3. Click the Virtual Machines tab.

  4. Find VMs of the VM template you want to use.

    If there are no VMs of the VM template, jump to Step 4.

    If you find one or more VMs that use the VM template, get each VM's VCN name. If the VCN's name is different from your VCN, click the Actions Menu icon and select Delete to delete the VM. You should not add VMs to different VCNs that use the same VM template.

  5. In the Build VMs tab, click + Create VM.

  6. In the Add Build VM dialog box, in Quantity, specify the number of VMs you want to allocate.

  7. In VM Template, select the Build VM template.
  8. In Region, specify the VM's region.
  9. In Shape, select the VM's shape.

    Wait for a few seconds. VB Studio calculates the number of Compute VM instances that can be created of the selected shape and displays it in the dialog box. If the required number of VM instances aren't available, choose another shape.

    Here's an example:

    Message displaying the selected shape's VM quota and the number of VMs running.
  10. In VCN Selection, select Custom.
  11. In VCN Compartment, select the compartment.

    If you're an Oracle Cloud OS Management Service (OSMS) user, don't select the OSMS compartment or a compartment with an OSMS policy.

  12. In VCN, select the VCN.
  13. In Subnets Compartments, select the compartments where your public subnets are. By default, it adds your VCN's compartment. If required, you can add more compartments.
  14. In Subnets, select a subnet. The list shows public subnets only.

    You can add multiple public subnets. If VB Studio can't create a VM on the first subnet you've added, it tries to create it on the second subnet, and so on.

  15. Click Add.

The new VM is in the Pending state until you manually start it or trigger a job's build that references the associated VM template.

Get the name and IP addresses of a VM's VCN
  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. In the Build VM's Details column, click Show Machine Details Details.
  4. Note the VCN's name.

    Here's an example of a VM that uses the default VCN:

    Build VM's details

    Here's an example of a VM that uses a custom VCN:

    User VCN's details

    The VM's name is displayed if it's in the Available state. If the VM is in the Stopped or the Pending state, click the Actions Menu icon and select Start to start the VM.

View a VM’s log

The VM’s log has entries for all events along with information about when the events occurred, the type of event, and event details.

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. In the Build VMs tab, select the VM, click Actions the Actions Menu icon and select Display Log.

  4. In the Provisioning Log window, review the log.

    To download the log file to your computer, click Download Log.

Start or stop a VM manually When a build of a job triggers, its VM starts automatically if it was in the stopped state. It takes some time to start a VM, and the user must wait for a VM to start before the job's build runs on it. Similarly, a VM stops automatically if no builds run on it during the sleep timeout period.

At times, you may want to manually start a VM before triggering a job's build or stop it to free resources immediately.

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. In the Build VMs tab, select the VM, click Actions the Actions Menu icon and select Start or Stop.

Delete a VM

When you delete a VM, it waits for all builds running on it to complete and won't accept new builds while it’s waiting for the running builds to complete. After all the builds are complete, it shuts down and is removed.

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. In the Build VMs tab, select the VM, click Actions the Actions Menu icon and select Delete.

    To delete multiple VMs, select them using the Ctrl or Shift keys, click Update Selected and select Delete Selected VMs.

Change the sleep timeout of all VMs

Set the sleepout time to stop inactive VMs automatically. By default, it is 30 minutes.

The higher the sleep timeout value, higher will be your cost as inactive VMs continue to be in the Available state for a longer time. If you don't expect your organization's users to run builds frequently, specify a lower sleep timeout.

When a VM starts from the Stopped state, it installs the operating system and all software packages of the VM template. This takes time and your organization's users must wait for the build to start until the VM is in the Available state. If you expect your organization's users to run builds frequently, specify a higher sleep timeout value.

  1. In the navigation menu, click Organization Organization.

  2. Click the Virtual Machines tab.

  3. Click Sleep Timeout.

  4. In the Sleep Timeout dialog box, change the timeout duration to define how long should a VM be in the Available state if no builds run on it.
  5. Click Save.
After adding VMs, you and your organization's members can configure jobs to use VM templates.

Software for Build VM Templates

VB Studio offers various software packages in the Software Catalog of Build VM templates. Some software packages are available by default in each VM template.

Platforms

These platforms are available:

  • Oracle Linux 8
  • Oracle Linux 7 (default)
  • Oracle Linux 6

Default Software Packages

These software packages are available by default in each VM template. You can't edit or remove these software packages from a VM template.

Software Version in Oracle Linux 8 Version in Oracle Linux 7 Version in Oracle Linux 6
Oracle Java SE 1.8.x 1.8.x 1.8.x
Ant 1.9.6 1.9.6 1.9.6
C++ Compiler (cpp/gcc) 8.3.x (or later) 4.8.x (or later) 4.4.x (or later)
Firefox 78.5.x (or later) 78.5.x (or later) 78.5.x (or later)
Git 2.27.x (or later) 1.8.x (or later) 1.7.x (or later)
Jq 1.5.x (or later) 1.5.x (or later) 1.5.x (or later)
JUnit 3 NA NA 3.8.x
JUnit 4 4.12 (or later) 4.11 (or later) 4.5 (or later)
Maven 3.6.x 3.6.x 3.6.x
Python2 (including Virtualenv) 2.7.17 (or later) 2.7.5 (or later) 2.6.6 (or later)
Ruby 2.5.5p157 (or later) 2.0.0p648 (or later) 1.9.3p488 (or later)
Xvfb 1.20.8 (or later) 1.20.4 (or later) 1.17.4 (or later)

Software Packages in the Software Catalog

Here's a list of the software available in the VB Studio's software catalog. If multiple versions are available, you can add only one version to the VM template.

Software Version in Oracle Linux 8 Version in Oracle Linux 7 Version in Oracle Linux 6 Notes
Docker NA

19.03.x (or later)

17.12.x

1.12.x

1.12.x  
Findbugs 3.0.x 3.0.x 3.0.x  
Fn NA 0.5.102 NA Requires Docker and OCIcli.
Gradle 6.7.x 6.7.x 6.7.x  
Groovy 3.0.x 3.0.x 3.0.x  
Helm NA 3.4.0 3.4.0  
Java SE

15.x

11.x

1.8.x (available by default)

1.7.x

15.x

11.x

1.8.x (available by default)

1.7.x

15.x

11.x

1.8.x (available by default)

1.7.x

You can add multiple versions of Java to a VM template. Ask your users to select the Java version they want to use in a job from the job's configuration page.
GraalVM EE for Java 8 20.3.x 20.3.x 20.3.x  
Kubectl 1.19.x 1.19.x 1.19.x  
Node.js

15.x

14.x

12.x

10.x

15.x

14.x

12.x

10.x

0.12.x

10.x

0.12.x

 
Node.js Driver for Oracle Database NA 1.13.x 1.13.x Requires Node.js 0.12 and Oracle Instant Client 12c.
OCIcli 2.15.x 2.15.x 2.15.x Requires Python3.
Oracle ATG 11 11.1.x 11.1.x 11.1.x  
Oracle Developer Studio 12c 12.5 12.5 12.5 12.5  
Oracle Forms Developer NA

12.2.1.4.0

12.2.1.3.0

12.2.1.4.0

12.2.1.3.0

 
Oracle Instant Client 12c NA 12.1.0.2.0 12.1.0.2.0  
Oracle JDeveloper Studio

12.2.1.4.0

12.2.1.3.0

11.1.1.7.1

12.2.1.4.0

12.2.1.3.0

11.1.1.7.1

12.2.1.4.0

12.2.1.3.0

11.1.1.7.1

 
Oracle JET Command-line Interface 9.1.x (or later) 9.1.x (or later) 9.1.x (or later) Requires Node.js
Oracle SOA Suite 12

12.2.1.4.0

12.2.1.3.0

12.2.1.2.0

12.2.1.1.0

12.1.3.0.0

12.2.1.4.0

12.2.1.3.0

12.2.1.2.0

12.2.1.1.0

12.1.3.0.0

12.2.1.4.0

12.2.1.3.0

12.2.1.2.0

12.2.1.1.0

12.1.3.0.0

 
Packer 1.6.x 1.6.x 1.6.x  
PSMcli 1.1.28 1.1.28 1.1.28 Requires Python3.
Python3

3.9.0

3.8.6

3.7.9

3.6.12

3.9.0

3.8.6

3.7.9

3.6.12

3.5.10

3.6.12

3.5.10

In Oracle Linux 8, Python 3.6.8 is available by default. To use it, you don't need to add Python3 to the VM template.

If you want to use Python 3.6.12, add Python3 3.6 to the VM template.

SQLcl

20.3.x

19.4.x

20.3.x

19.4.x

20.3.x

19.4.x

 
Terraform 0.13.x 0.13.x 0.13.x  

Add Users to IDCS

To add users to VB Studio and its projects, make sure they are added to IDCS and assigned appropriate VB Studio roles.

If you want to federate with your existing identity provider, see Federating with Identity Providers.

To add users manually to IDCS, follow these steps:

  1. Open the Oracle Cloud Console page.
  2. In the upper-left corner, click Navigation Menu the Menu icon.
  3. Under Governance and Administration, select Identity, and then select Federation.
  4. On the Federation page, click the identity service provider's link.
  5. On the Identity Provider Details page, click Create IDCS User.
  6. In the Create IDCS User dialog box, enter the new user's details and click Create.
  7. To send the password reset instructions and URL to the new user, click Email Password Instructions.
  8. Click close.
  9. On the Identity Provider Details page, click the user's IDCS Username link.
  10. On the User Details page, click Manage Service Roles.
  11. On the Manage Service Roles page, search for the service with Developer Cloud Service description, click the Actions icon (three dots) and select Manage Instance Access.
  12. On the Manage Access page, in the Instance Role column, select the role you want to grant to the user. A user must be assigned one of these two roles to access VB Studio.
    This VB Studio role... Enables a user to:
    DEVELOPER_ADMINISTRATOR Set up VB Studio, manage all projects, manage VMs and VM templates, and update the organization details. The user with this role is also called the Organization Administrator.

    Assign this role role to users who can administer VB Studio.

    DEVELOPER_USER Create and access VB Studio projects. All non-admin users of VB Studio must be assigned this role.

    Note that this role doesn't allow the user to update the organization details.

  13. Click Save Instance Settings.
  14. On the Manage Service Roles page, click Apply Role Settings.

For more details about adding users to IDCS and assigning them roles, see Managing Oracle Identity Cloud Service Users in the Console and Managing Instance Roles in the Console.