Nautilus

Nautilus

To access the Nautilus namespace, first make an account at https://portal.nrp-nautilus.io/ . Once you have done so, email beocat@cs.ksu.edu and request to be added to the Beocat Nautilus namespace (ksu-nrp-cluster). Once you have received notification that you have been added to the namespace, you can continue with the following steps to get set up to use the cluster resources.

1. SSH into headnode.beocat.ksu.edu
2. SSH into fiona (fiona hosts the kubectl tool we will use for this)
3. Once on fiona, use the command ‘cd ~’ to ensure you are in your home directory. If you are not, this will return you to the top level of your home directory.
5. From there you will need to create a .kube directory inside of your home directory. Use the command ‘mkdir ~/.kube’
6. Login to https://portal.nrp-nautilus.io/ using the same login previously used to create your account (this will be your K-State EID login)
7. From here it is MANDATORY to read the cluster policy documentation provided by the National Research Platform for the Nautilus program. You can find this here. https://docs.nationalresearchplatform.org/userdocs/start/policies/
a. This is to ensure we do not break any of the rules put in place by the NRP.
8. Next, return to the website specified in step 5, in the top right corner of the page press the “Get Config” option.
a. This will download a file called ‘config’
9. You will need to move the file to your ~/.kube directory created in step 4.
a. To do this you can copy and paste the contents through the command line
b. You can also utilize the OpenOnDemand tool to upload the file through the web interface. Information for this tool can be found here: https://support.beocat.ksu.edu/Docs/OpenOnDemand
c. You can also use other means of moving the contents to the Beocat headnodes/your home directory, but these are just a few examples.
d. NOTE: Because we added a period before the directory name it is now a hidden directory, and the directory will not appear when running a normal ‘ls’, to see the directory you will need to run “ls -a” or “ls -la”.
10. Once you have read the required documentation, created the .kube directory in your home directory, and placed the config file in the '~/.kube' directory, you are now ready to continue!
11. Below is an example pod that can be used. It does not request much in the way of resources so you will likely need to change some things. Be sure to change the “name:” field underneath “metadata:”. Change the text “test-pod” to “{eid}-pod” where ‘{eid}’ is your K-State ID. It will look something like this “dan-pod”.

apiVersion: v1
kind: Pod
metadata:
  name: test-pod
spec:
  containers:
  - name: mypod
    image: ubuntu
    resources:
      limits:
        memory: 400Mi
        cpu: 100m
      requests:
        memory: 100Mi
        cpu: 100m
    command: ["sh", "-c", "echo 'Im a new pod' && sleep infinity"]

12. Place your .yaml file in the same directory created earlier (~/.kube).
13. If you are not already in the .kube directory enter the command “cd ~/.kube” to change your current directory.
14. Now we are going to create our ‘pod’. This will request a ubuntu pc using the specifications from above.
a. To do this enter the command “kubectl create -f pod1.yaml” NOTE: You must be in the same directory that you placed the pod1.yaml file in (in this situation, the above pod config was put into a file named pod1.yaml).
b. If the command is successful you will see an output of “pod/{eid}-pod created”.
15. You will need to wait until the container for the pod is finished creating. You can check this by running “kubectl get pods”
a. Once you run this command, it will output all the pods currently running or being created in the namespace. Look for yours among the list of pods, the name will be the same name specified in step 10.
b. Once you locate your pod, check its STATUS. If the pod says Running, then you are good to proceed. If it says Container Creating, then you will need to wait just a bit. It should not take long.
16. You can now execute and enter the pod by running “kubectl exec -it {eid}-pod -- /bin/bash”. Where ‘{eid}-pod’ is the pod created in step 13/the name specified in step 10.
a. Executing this command will open the pod you created and run a bash console on the pod.
b. NOTE: If you have trouble logging into the pod, and are met with a “You must be logged in to the server, you can run “kubectl proxy”, and after a moment, you can cancel the command with a “crtl+c”. This should remedy the error.

Additional documentation for Kubernetes can be found on the Kubernetes website https://kubernetes.io/docs/home