NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Create a Windows Azure Ubuntu Virtual Machine

  1. Log in to Windows the Microsoft Azure Management Portal
    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .
  2. Go to VM Screen, select "+ NEW" from the lower left corner of the screen.
  3. On the pane that appears select, Compute > Virtual Machine > Quick Create.

    Code Block
    DNS Name: pick something unique and memorable
    Image: Ubuntu Server 13.04
    New Password/Confirm: provide a good password for the azureuser
    Region/Affinity Group: West US
          
    
        
  4. Click Create a virtual machine.

  5. Once your virtual machine is created, select it from the VM screen.

  6. Go to the Endpoints menu.

    (+ Add) an Endpoint at the bottom of the screen.

    Code Block
     Provide the following information
        Name: HTTP
        Public Port: 80
        Private Port: 8000
          
    
        
  7. Restart the VM from the management console.

    Troubleshooting note: You may get a message that Endpoint was successfully created but restart failed. In this case, go back to Dashboard (Management Console) and click Restart. In some cases, multiple attempts may be required.

    At this point, it appears that a restart is not mandatory to continue with configuration.

  8. Now you can login to it and start configuring things.

  9. Login to your VM via ssh as: azureuser <password provided at vm build - Step 3)
  10. Things to do once you're in Ubuntu.

    1. sudo apt-get update
      1. enter password (azureuser password from Step 3)

    2. sudo apt-get upgrade -y
    3. sudo apt-get install git python-pip -y
    4. sudo pip install virtualenv

...

  1. Install Python 2.7. For current Debian-based Linux distributions (such as Ubuntu), BSD and Mac Python 2.7 is usually installed. However Redhat-based Linux distributions, such as RHEL and CentOS, are sometimes behind the curve and do not have Python 2.7. As of this writing, CentOS 6.4 is at Python 2.6, which is well on its way to EOL. Python 2.6 may work, but code will be written with 2.7 and 3.3+ in mind. Below are instructions for Ubuntu Linux 13.04+.

    sudo apt-get install python2.7 python2.7-dev python-virtualenv

  2. Install PIP.

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include

    sudo apt-get install python-pip

  3. Install virtualenv.

    sudo apt-get install python-virtualenv

  4. Install Git.

    sudo apt-get install git

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include

    sudo apt-get install git

  5. Install the prerequisites for MySQL-Python.

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include

    sudo apt-get install build-essential python-dev libmysqlclient-dev

...

In order to test uploading and running bundles in CodaLab, you will need to have a Windows Azure storage account

Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include
. Once you have set up your Azure account, log on to the Azure Portal
Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include
and follow the steps in this section.

  1. Log on to the Azure Portal
    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    Log on to the Azure Portal.
  2. In the left pane, click Storage.
  3. Select your storage account.
  4. At the bottom of the dashboard, click Manage Access Keys. Copy your access keys, you'll need them later.
  5. At the top of the dashboard page, click Containers.
  6. At the bottom of the Containers page click Add.
  7. Create a new container named "bundles". Set the Access to "Private".
  8. Add another container named "public". Set the Access to "Public Blob".

Add a Service Bus Namespace

  1. Install azure-cli

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .

    In Ubuntu it can be installed using the following command:

    Code Block
     sudo apt-get install nodejs-legacy
     sudo apt-get install npm
     sudo npm install -g azure-cli

    To login run the following command:

    azure login

    Copy the code offered to you, above, and open a browser to http://aka.ms/devicelogin

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    . Enter the code, and then you are prompted to enter the username and password for the identity you want to use. When that process completes, the command shell completes the log in process.

  2. From command line azure sb namespace create <name> <location> where <location> can be "East US"

  3. Log on to the Azure PortalPortal
    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .
  4. In the left pane, click Service Bus.
  5. Select the service bus you just created.
  6. At the top of the screen click Queues.
  7. Click Create a new queue.
  8. Click Quick Create and create a new queue named "compute".
  9. Click Create A New Queue.
  10. At the bottom of the screen, click New, and create another queue named "response".
  11. In the left pane, click Service Bus.
  12. At the bottom of the page, click Connection Information.
  13. Copy the following connection information:
    • Namespace name
    • Default issuer
    • Default key

...

  1. Make sure you have the dependencies (Python 2.7 and virtualenv). If you're running Ubuntu:

          sudo apt-get install python2.7 python2.7-dev python-virtualenv
    
        
  2. Clone the CodaLab repository:

          git clone https://github.com/codalab/codalab-cli
    cd codalab-cli
    
        
  3. Run the setup script (will install things into a Python virtual environment):

          ./setup.sh
    
        
  4. Set your path to include CodaLab (add this line to your .bashrc):

          export PATH=$PATH:<path to codalab-cli>/codalab/bin
    
        
  5. Optional: include some handy macros (add this line to your .bashrc):

          . <path to codalab-cli>/rc
    

Install CodaLab

  1. rc
    
        

Install CodaLab

  1. Fork

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    the CodaLab repo
    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    Fork the CodaLab repo from GitHub.

  2. Clone your fork.

  git clone https://github.com/<username>/codalab.git

For more details and recommended practices, see Developer Guidelines.

Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include

Configure Your Local Environment

...

  1. Run the dev_setup script.

    Windows

          cd codalab
    .\dev_setup.bat
    
        

    If you are going to use SQL Server as a database, you will need to install the Python PyODBC library. Before running dev_setup, you can download the installer, then run the setup script as follows (assuming the installer was downloaded at the root of a D drive):):

          cd codalab
    dev_setup.bat D:\pyodbc-3.0.7.win-amd64-py2.7.exe
    
        

    Linux

          cd codalab
    source ./dev_setup.sh
    
        
  2. Activate the virtual environment.

    Windows

          venv\Scripts\activate
    
        

    Linux

          source venv/bin/activate
    
        

Install App Schema and Default Data

...

  1. Open your local configuration file (local.py). If there is no local.py, save a copy of local_sample.py named local.py in the same directory.
  2. In the Azure storage section, enter your Azure account details:

    Code Block
    DEFAULT_FILE_STORAGE = 'codalab.azure_storage.AzureStorage'
    AZURE_ACCOUNT_NAME = "<enter name>"
    AZURE_ACCOUNT_KEY = '<enter key>'
    AZURE_CONTAINER = '<enter container name>'
    
    PRIVATE_FILE_STORAGE = 'codalab.azure_storage.AzureStorage'
    PRIVATE_AZURE_ACCOUNT_NAME = "<enter name>"
    PRIVATE_AZURE_ACCOUNT_KEY = "<enter key>"
    PRIVATE_AZURE_CONTAINER = "<enter container name>"
    
    BUNDLE_AZURE_CONTAINER = "<enter the name of your bundle container>"
    BUNDLE_AZURE_ACCOUNT_NAME = PRIVATE_AZURE_ACCOUNT_NAME
    BUNDLE_AZURE_ACCOUNT_KEY = PRIVATE_AZURE_ACCOUNT_KEY
          
    
        
  3. In the Service Bus section, enter your service bus connection information:

    Code Block
    SBS_NAMESPACE = '<enter the name of your service bus>'
    SBS_ISSUER = 'owner'
    SBS_ACCOUNT_KEY = '<enter value for 'default key'>'
    Note
    titleImportant

    Do not change the values for DEFAULT_FILE_STORAGE and PRIVATE_FILE_STORAGE, as these parameters contain the name of the Python class which implements the Azure storage back-end for Django.

  4. In the DATABASES section, enter the configuration settings for the database you want to use.

    SQL Server*

    Code Block
    DATABASES = {
        'default': {
            'ENGINE': 'sql_server.pyodbc',
            'NAME': 'somename',
            # Leaver user and password blank to use integrated security
            'USER': '',
            'PASSWORD': '',
            'HOST': '(localdb)\\v11.0', 
            'PORT': '',
            'OPTIONS': {
               'driver': 'SQL Server Native Client 11.0',
            }
        }

    MySQL

    Code Block
    DATABASES = {
        'default': {
            'ENGINE':  'django.db.backends.mysql',
            'NAME': 'MySQL_DevDB',
            'USER': 'someuser',
            'PASSWORD': 'somepassword',
            'HOST': 'someserver', # Empty for localhost through domain sockets or '127.0.0.1' for localhost through TCP.
            'PORT': '',           # Set to empty string for default.
        }    }
Info

If you want to use MySQL

Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include

Info

If you want to use MySQL you'll need to manually install

Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include
it and create a database before proceeding. CodaLab setup does not install MySQL.

...

  1. Make sure you have a valid management certificate to connect to the Service Management endpoint. This tutorial explains how to create a certificate and upload it to the Azure management portal: http://azure.microsoft.com/en-us/documentation/articles/cloud-services-python-how-to-use-service-management/

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .

  2. Open codalab/codalabtools/compute/enableCORS.py in a text editor, and update account_name and account_key with the account name and key for your blob storage account:

    Code Block
    import sys
    import yaml
    from os.path import dirname, abspath
    # Add codalabtools to the module search path
    sys.path.append(dirname(dirname(abspath(__file__))))
    
    from codalabtools.azure_extensions import (Cors,CorsRule,set_storage_service_cors_properties)
    
    account_name = "<your blob storage account name>"
    account_key = "<your blob storage account key>"
    cors_rule = CorsRule()
    cors_rule.allowed_origins = '*' # this is fine for dev setup
    cors_rule.allowed_methods = 'PUT'
    cors_rule.exposed_headers = '*'
    cors_rule.allowed_headers = '*'
    cors_rule.max_age_in_seconds = 1800
    cors_rules = Cors()
    cors_rules.cors_rule.append(cors_rule)
    set_storage_service_cors_properties(account_name, account_key, cors_rules)
    
          
    
        
  3. Save your changes, activate your virtual environment and run the script:

    Windows

          python scripts\cors-enable.py
    
        

    Linux

          python scripts/cors-enable.py
    
        

Initialize the Database

To initialize the database, you will need to run a few standard Django commands, and the CodaLab database initialization script.

...

  • You can already run the Django web site on your local machine as described on this page.as described on this page

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .

  • You have also forked the codalab-cli

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    You have also forked the codalab-cli project and have gone through the steps listed in the Readme
    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .

With those assumptions in place:

...

  1. Use the following command to start the CodaLab server locally.

          python manage.py runserver
    
        
  2. Open a browser and navigate to http://127.0.0.1:8000://127.0.0.1:8000

    Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    to preview the site.

  3. When your next coding session comes along, remember to work in the virtual environment you created:

    Windows

          venv\Scripts\activate
    
        

    Linux

          source venv/bin/activate
    
        

Note: If you experience database errors try deleting the database file (\codalab\codalab\dev_db.*) and run syncdb again. After creating a new database be sure to run initialize.py in the scripts folder in order to insert initial data required by the app.

...

  1. Open a command prompt and activate your CodaLab virtual environment.
  2. Start the first compute worker as shown here:

          cd codalab
    python worker.py
    
        
  3. Open a second command prompt and activate your CodaLab virtual environment.

  4. Start the second compute worker as shown here:

          cd codalabtools\compute
    python worker.py
    
        
  5. If you plan to test competitions locally, open a third command prompt and activate the virtual environment for the CodaLab CLI, then start the bundle server:

          cl server
    
    
        

Execution Using Docker

Every execution on CodaLab (should ideally) happen in a docker

Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include
container, which provides a standardized Linux environment that is lighterweight than a full virtual machine.

The current official docker image is codalab/ubuntu, which consists of Ubuntu 14.04 plus some standard packages. See the CodaLab docker registery.

To install docker on your local machine (either if you want see what's actually in the environment or to run your own local CodaLab instance), follow these instructions

Multiexcerpt include
nopaneltrue
MultiExcerptNameExitDisclaimer
PageWithExcerptwikicontent:Exit Disclaimer to Include
:

Code Block
sudo sh -c "echo deb https://get.docker.io/ubuntu docker main > /etc/apt/sources.list.d/docker.list"
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9
sudo apt-get update
sudo apt-get install lxc-docker
sudo useradd $USER docker
Then, to test out your environment, open a shell (the first time you do this, it will take some time to download the image):
                docker run -t -i codalab/ubuntu:1.8

              

Now, let us integrate docker into CodaLab. First, we need to setup a job scheduling system (that manages the deployment of runs on machines). Note that CodaLab itself doesn't do this, so that it can be easily integrated into different systems. An easy way to set this up is to use q from Percy Liang's fig package:

Code Block
git clone https://github.com/percyliang/fig
# Add fig/bin/q to your $PATH
q -mode master   # Run in a different terminal
q -mode worker   # Run in a different terminal
Now, let us tell CodaLab to use q and run things in docker (these two things are orthogonal choices). Edit the .codalab/config.json as follows:
Code Block
 "workers": {
    "q": {
        "verbose": 1,
        "docker_image": "codalab/ubuntu:1.8"
        "dispatch_command": "python $CODALAB_CLI/scripts/dispatch-q.py"
    }
}

 

To test it out:
Code Block
cl work-manager -t q                 # Run in a different terminal
cl run 'cat /proc/self/cgroup' -t    # Should eventually print out lines containing the string `docker`