GitHub Codespaces Install Guide

How to set up Wallaroo Community Edition using GitHub Codespaces

The following details how to set up Wallaroo Community Edition using GitHub Codespaces. This provides a quick method of setting up Wallaroo Community Edition with just a few commands. You get the free license from the Wallaroo Community Edition Portal site, and the rest of the process is handled by GitHub and Wallaroo.

Prerequisites

Installation Steps

  1. From the Wallaroo Community Edition Portal page, follow the registration instructions. If a Wallaroo Community Edition license already exists for this account, enter the same name and email address to retrieve the registration link.

  2. Download the Wallaroo Community Edition license. This provides both the Wallaroo Community Edition license in YAML format and the base64 encoded version. Store both in a secure location. The base64 ended version will be used in this process.

  3. From the License Download page:

    1. Select Download license file. This provides two files: The YAML version of the license file, and an encoded base 64 version of the license file.
    2. Select Github Codespaces, then select Click to install Wallaroo in your GitHub Codespaces.

  4. From the Create codespace GitHub page for Wallaroo Community, set the following:

    Wallaroo GitHub Install Options
    1. Dev container configuration: Set to Wallaroo Codespaces Data Science.
    2. Region: Select the region where the codespace will run. This should be the region geographically closest to the end user.
      1. Europe West
      2. Southeast Asia
      3. US West
      4. US East
    3. Machine Type: Set the number of CPUs to use. Leave as 16-cores - anything less the containers will not run.
    4. Wallaroo Community Edition License: Provide the base64 version of the Wallaroo license here.

  5. When complete, select Create Codespace. Wait until the process is complete - this usually takes about 15 minutes.

To see the installation process in action, use one of the following options:

  • Enter either Control-Shift-P or Command-Shift-P (for MacOS systems) and select Codespaces: View Creation Log.
  • Select from the lower left corner Codespaces and then View Creation Log.

Once the entry “Finished configuring codespace” is displayed, the Wallaroo Community Edition installation is complete.

Wallaroo Community Edition First Login

If this is your first login, you will receive an email invitation for the email address connected to this URL with a temporary password. Follow the link provided in the email. If not already logged into GitHub, a prompt will appear for you to login to GitHub to manage the port forwarding required to connect to the Wallaroo Community Edition instance through your browser.

To login to your new Wallaroo instance, enter the email address and temporary password associated with the license. Enter a new password twice to set a new permanent password, and you will be logged into the Wallaroo Community Edition instance.

Subsequent logins will are performed through the same URL.

Stopping and Starting Wallaroo Community

To start and stop the Wallaroo Community Edition codespace:

  • To stop the current Wallaroo Community Edition codespace:
    • From the Wallaroo Community Edition Codespace page, from the bottom left select Codespaces, then select the action Stop Current Codespace.
    • The other option is to press F1 and select Stop Current Codespace.
  • To start a Wallaroo Community Edition codespace:
    • Access your GitHub Codespaces page from GitHub by selecting your user profile icon in the upper right corner, then selecting My Codespaces.
    • From your GitHub Codespaces page, select your Wallaroo Community Edition code space.
    • From the menu list on the right side, select Open In…, then Open in Browser to launch the Wallaroo Community Edition Codespace page. This will launch the Wallaroo Community Edition containers and make them available once they are done starting up.

See Setting your timeout period for GitHub Codespaces for information on timeout settings.

Additional GitHub Codespaces Options

Update the Wallaroo Community Edition License

When Wallaroo Community Edition is installed through GitHub Codespaces, the base64 hash of the Wallaroo license used in the installation process is stored in GitHub.

To update this license:

  1. Select your GitHub user profile, then Settings.

  2. Select Codespaces, then Codespaces secrets. The Wallaroo Community Edition license is listed as WALLAROO_LICENSE. Use Update to update the license or Delete to remove if it is no longer needed.

    Wallaroo GitHub Codespaces Community License

Open Ports for Multiple Users

To provide for multiple users, the following ports must be set from private to public. This step is not required for users who will be the only one accessing Wallaroo Community Edition though their codespace.

  • keycloak: Used for authentication to the Wallaroo service.
  • hub: Used for the JupyterHub service.
  • dashboard: Used for the Wallaroo Dashboard.

To update the network settings:

  1. Access the Wallaroo Community Edition codespace settings by entering either Control-Shift-P or Command-Shift-P (for MacOS systems) and select View: Toggle Terminal.
  2. Right click keycloak, hub, and dashboard and set Port Visibility to Public.