# Virtual Server Deployment Guide

## Overview
This document will take you through the steps to get access to the LinuxONE Community Cloud, deploy a virtual server and start using them in your projects.    

## Steps

1. Request access to LinuxONE Community Cloud
2. First time setup
3. Deploy your LinuxONE virtual server
4. Log in to your LinuxONE virtual server
5. (optional) Add Container Service to your account

## Step 1. Request access to LinuxONE Community Cloud.
1) In a browser, go to the [LinuxONE Community Cloud website](https://developer.ibm.com/linuxone/home-l1cc30-test/).

   ![alt text](images/RequestAccess.png "DeveloperWorks LinuxONE Home")

2) Click **Try virtual machines** now.

3) Complete the required fields on the registration form.

   ![alt text](images/form.png "Registration form")

4) Provide a mobile phone number that is capable of receiving SMS messages.
    1) Select a **country code**.
    2) Enter your **mobile phone number**.  *Do not use dashes (-)*.
    3) Click **Get Code**.

   ![alt text](images/getcode.png "Get verification code")

   >Note: You will see a countdown timer.  If you don’t get a code within a reasonable amount of time, you can request a new one when the timer expires. Do not repeatedly click 'Get Code'.  Each click will send you a new code, invalidating the previous one.

5) Go to your mobile phone and check for an SMS message from LinuxONE.  

   ![alt text](images/phone.png "SMS code")

6) Complete your registration.
    1) Enter the **LinuxONE Community Cloud registration code**.
    2) Click **Request your trial**.

   ![alt text](images/requesttrial.png "Submit registration form")    

7) You will see this THANK YOU page indicating your registration is successful.

   ![alt text](images/thankyou.png "Registration successful message")

9) Check your email for registration confirmation and click activation link.

   ![alt text](images/activation.png "Activation message")

8) You now have access to the LinuxONE Community Cloud self service portal.
    1) Click **Sign In** and use the email address and password you set up previously.

   ![alt text](images/signin.png "Welcome email")


## Step 2 First time setup

1) Once signed you should be at the self service portal.
    ![alt text](images-server/selfservice-portal.png "Self-Service Portal page")


2) Now is a good time to create or import an SSH key. An SSH public key is required to deploy Linux instance. The instance can only be accessed with your private key that matches the public key.

    1) Click your **username** from the upper right corner of the Home page.
    2) Select **Manage SSH Key Pairs**.

   ![alt text](images-server/manage-ssh-keys.png "Manage SSH keys")

    3) If you already have a public SSH key you wish to use with this cloud:    
        1. Click **Import**.
        2. Enter a **Key Name** for this key.
        3. Browse your local file system to select the **public key path**.
        4. Click **Upload your public key**.

   ![alt text](images-server/upload-key.png "Import SSH key")

    4) If you want to create a new SSH key pair:     
        1. Click **Create**.
        2. Enter a **Key Name** for this key.
        3. Click **Create a new key pair**.   
        4. A pop-up window will appear asking you to save **yourkey. pem** file. This is your private key.  Please save it to a secure location.  Once this operation is complete, there is no way to retrieve this key. Click **OK** to save the file.

   ![alt text](images-server/create-key.png "Create SSH key")
   ![alt text](images-server/pem-file.png "Save SSH private key")   

## Step 3 Deploy your LinuxONE virtual server

1) Go to the **Home** page, **Infrastructure** section and **Virtual Servers** service.
    1. Click **Manage Instances**.

   ![alt text](images-server/manage-instances.png "Manage instances")

    2. Click **Create**.

   ![alt text](images-server/create-server.png "Create server")

2) Select a virtual server type.

    1. If this server is for generic purpose use, select **General purpose VM**.

   ![alt text](images-server/create-server-type-general.png "Create server type General purpose")

   2. If this server is for a Hackathon event, select **Hackathon**.  A valid event code is required.

   ![alt text](images-server/create-server-type-hackathon.png "Create server type Hackathon")

3) Provide details information for this instance.  Enter:

    1. An **Instance Name**, without any spaces or special characters.
    2. An **Instance Description**.

   ![alt text](images-server/create-server-instance-details.png "Create server details")

4) Select the desired Linux image.

   ![alt text](images-server/create-server-image.png "Create server image")

5) Select the desired flavor (configuration).

   ![alt text](images-server/create-server-flavor.png "Create server flavor")

   >Note: If you selected the **Hackathon** server type, you will not see this section. A flavor of **LinuxONE-Medium** will be selected by default.

6) Select the SSH key to use.

   ![alt text](images-server/create-server-select-key.png "Create server SSH key")

7) Verify that all the information is correct and click **Create**.

   ![alt text](images-server/create-server-submit.png "Create server submit")

8) Watch the status of your newly deployed instance go through the following phases of start up:  **networking**, **spawning**,  **Active**.  When your instance status changes to active, it is ready for use.

   ![alt text](images-server/create-server-status.png "Create server status")

   Write down the IP address of your instance. You will need it to log in.

## Step 4 Log in to your LinuxONE virtual server

### From Mac OS X or Linux using Terminal

1) Open the Terminal application.
2) Ensure that you have the SSH private key used to deploy the server.
3) If you have not done so already, change the permission bits of this key to 600.

   ```sh
   chmod 600 /path/to/key/keyname.pem  
   ```
4) Log in to the linux1 user ID with SSH.

   ```sh
   ssh –i /path/to/key/keyname.pem linux1@serveripaddress
   ```
### From Windows using PuTTY

1) Set up PuTTY to use the SSH key for your server.  Refer to the [Setting up PUTTY on Windows to use ssh private key](http://developer.ibm.com/linuxone/wp-content/uploads/sites/57/2016/02/PUTTY-Set-up.pdf) tutorial.

2) Log in to the linux1 user ID.

## Important notes about your server:
1) You can use ‘sudo’ to execute commands that require root authority.

2) It could take up to 10 minutes to format and mount the /data disk.  Issue the following command to verify the /data disk is available before continuing:
   ```sh
   df -h
   ```
   ![alt text](images-server/df.png "Check /data disk")

3) Firewall is enabled. Only the SSH port is open.  Modify the firewall rules with iptables if you need other ports opened. For example:
   ```sh
   iptables -I INPUT -p tcp --dport <port#> -j ACCEPT
   ```
   If you want to make your changes permanently, issue this command:
   ```sh
   iptables-save > /etc/sysconfig/iptables
   ```

4) You must log in with the user ‘linux1’ with your SSH private key. No modification (use of password authentication, for example) is allowed.

5) The user ‘root’ login is disabled for security reasons. No modification is allowed.

6) There is no backup for your virtual server.  It is the end user’s responsibility to back up any critical data.

## Step 5 (optional) Add Container Service to your account

1) Go back to the [Starting Page](https://developer.ibm.com/linuxone/home-l1cc30-test/)

2) Click "Try Containers"   
    ![alt text](images-server/try-containers.png "Try Containers")

3) Enter your email address and you will be immediately recognized as already registered and prompted to add container Service
    ![alt text](images-server/container-entitlement.png "Containers entitlement")      

4) Look for activation confirmation.
    ![alt text](images-server/container-activation.png "container activation")

5) You will receive an email stating that your container server will expire in 24 hours.  Click the link in the email to extend it for 30 days.
    ![alt text](images-server/container-extention.png "Container service extention")

6) The email and password that you previously set up will now work on the Container service provided by IBM Cloud private
   Click [here](https://container.cloud.marist.edu:8443/oidc/login.jsp) to get started with containers on LinuxONE.
    [![alt text](images-server/icp-login.png "IBM Cloud Private")](https://container.cloud.marist.edu:8443/oidc/login.jsp)  

7) Once you have logged in with username and password you are presented with a Welcome Page.
   Click [here](https://container.cloud.marist.edu:8443/console/welcome) or bookmark https://container.cloud.marist.edu:8443/console/welcome to get back to the Welcome Page or re-login if you get lost.

9) Once logged in look at the upper right corner of screen and click the Catalog.  This will take you to predefined Helm Charts for you to configure and deploy.
    ![alt text](images-container/catalog-click.png "catalog")

10) There are also links to Documentation and Support
    ![alt text](images-container/doc-support-click.png "docs and support")

11) Once you click the catalog you are taken to a catalog of predefined helm charts that can be customized and installed.
    ![alt text](images-container/catalog-charts.png "catalog of charts")

12) Once installed, click "Workloads" and then "Helm Releases" in the upper left side of screen for a listing of your deployed helm charts.  Also there are many other areas to check out as well.
    ![alt text](images-container/helm-message.png "Helm Chart Message")
    ![alt text](images-container/DeployedHelmCharts.png "DeployedHelmCharts")