diff --git a/README.md b/README.md index d45b0a20184b10fc81feb712d0aa9dcbeab41220..2525aecc0c05ac955c8c788a34f47c8a737a0dab 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,195 @@ -# hpc-factory-proxy-nodes-notes +# Project Documentation +This project involves the following stages: -## Getting started +--- -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +## 1. Creating an OpenStack Account -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +To access our cloud infrastructure, follow these steps: -## Add your files +1. Ensure you are connected to the UAB Campus Network or VPN. +2. Visit [cloud.rc.uab.edu](https://cloud.rc.uab.edu) to verify access. +3. Contact the team to request an account if you don’t have one. -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +--- +## 2. Deploying an Ad-hoc Cluster + +### Prerequisite + +- **Bright (now Nvidia) cluster key:** A Bright cluster key is required. As of Nov 1, 2024, creating new accounts on Bright's platform is restricted. A limited supply of keys is available. + +### Steps to Deploy: + +1. Clone the repository: + ```bash + git clone git@gitlab.rc.uab.edu:rc/cod-heat-stack.git + cd cod-heat-stack + ``` + +2. Set up a virtual environment and install dependencies: + ```bash + python3 -m venv venv + source venv/bin/activate + pip install -r requirements.txt + ``` + +3. Update the following variables in `group_vars/all`: + - `ssh_key`: Public SSH key. + - `product_key`: Bright Easy8 product key. + - `password`: Plain text password. + +4. Deploy the cluster: + ```bash + ansible-playbook main.yaml -v + ``` + +5. Verify deployment: + ```bash + openstack stack list + ``` + +### Access the Master Node: + +1. Retrieve the floating IP: + ```bash + COD_HEAD_IP=$(openstack stack output show <your-stack-name> head_a_floating_ip -f value -c output_value) + ``` + +2. SSH into the head node: + ```bash + ssh root@$COD_HEAD_IP + ``` + +### Additional Steps: + +- For OpenOnDemand, login nodes, and compute nodes, refer to the `/CRI_XCBC` directory on the master node and run the respective playbooks. + +### Cluster Deletion: + +To delete a cluster: +```bash +openstack stack delete -y --wait <your-stack-name> ``` -cd existing_repo -git remote add origin https://gitlab.rc.uab.edu/rc/hpc-factory-proxy-nodes-notes.git -git branch -M main -git push -uf origin main -``` -## Integrate with your tools +--- + +## 3. Setting Up a GitLab Runner + +GitLab Runners are agents that execute jobs defined in `.gitlab-ci.yml`. + +### Types of Runners: + +- **Shared:** Available to all projects on the instance. +- **Group:** Available to projects within a group. +- **Project:** Specific to a project. + +### Steps to Set Up: + +1. **Create an Access Token:** + + - Navigate to `Settings -> Access Tokens` in GitLab. + - Specify a name, expiration date, role (`Owner`), and scope (`create_runner`). + - Save the token securely, as it will only be shown once. + +2. **Register a Runner:** + + Use the appropriate command for your use case: + + - **Group Runner:** + ```bash + curl -sX POST https://<GITLAB_URL>/api/v4/user/runners \ + --data runner_type=<RUNNER_TYPE> \ + --data "group_id=<target_group_id>" \ + --data "description=gitlab-ci-runner" \ + --data "tag_list=<your comma-separated tags>" \ + --header "PRIVATE-TOKEN: <your_access_token>" + ``` + + - **Project Runner:** + ```bash + curl -sX POST https://<GITLAB_URL>/api/v4/user/runners \ + --data runner_type=<RUNNER_TYPE> \ + --data "project_id=<target_project_id>" \ + --data "description=gitlab-ci-runner" \ + --data "tag_list=<your comma-separated tags>" \ + --header "PRIVATE-TOKEN: <your_access_token>" + ``` -- [ ] [Set up project integrations](https://gitlab.rc.uab.edu/rc/hpc-factory-proxy-nodes-notes/-/settings/integrations) + - **Shared Runner:** + ```bash + curl -sX POST https://<GITLAB_URL>/api/v4/user/runners \ + --data runner_type=<RUNNER_TYPE> \ + --data "group_id=<target_group_or_project_id>" \ + --data "description=shared-runner" \ + --data "tag_list=<your comma-separated tags>" \ + --header "PRIVATE-TOKEN: <your_access_token>" + ``` -## Collaborate with your team +### Notes: -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +- The runner status will display as `Never contacted` until the actual runner is configured. +- Save the `token` value returned by the API for later use. -## Test and Deploy +--- -Use the built-in continuous integration in GitLab. +## 4. Building and Deploying Proxy Nodes -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +### Prerequisites: -*** +- **Docker Desktop:** Ensure Docker is installed and running. +- **GitLab Access:** You should have credentials for GitLab. If using two-factor authentication (2FA), use a personal access token instead of a password. -# Editing this README +### Steps: -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +1. **Authenticate to the GitLab Container Registry:** + ```bash + docker login gitlab.rc.uab.edu:4567 + ``` -## Suggestions for a good README + If you use 2FA, replace your password with a personal access token. -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +2. **Download or Pull an Image (Optional):** + ```bash + docker pull <image_name>:<tag> + ``` -## Name -Choose a self-explaining name for your project. + Replace `<image_name>` and `<tag>` with the actual image name and tag you need. -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +3. **Tag the Image for GitLab Registry:** + ```bash + docker tag <local_image_name>:<tag> gitlab.rc.uab.edu:4567/<your_gitlab_namespace>/<project_name>:<tag> + ``` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. + Replace: + - `<local_image_name>` and `<tag>` with the local image name and tag. + - `<your_gitlab_namespace>/<project_name>` with your actual GitLab project path. -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +4. **Push the Image to GitLab’s Container Registry:** + ```bash + docker push gitlab.rc.uab.edu:4567/<your_gitlab_namespace>/<project_name>:<tag> + ``` -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +### Deployment Pipeline: -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +You can now schedule a pipeline to build and deploy proxy nodes. Use the same process for additional proxy nodes, such as HTTP proxies. -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +--- -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +## Screenshots -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +## Deploy and Build Pipeline for SSH Proxy Node -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +### Build Pipeline Example +Below is a screenshot showing the build pipeline for the SSH proxy node: -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. + -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +### Deploy Pipeline Example +Below is a screenshot showing the deploy pipeline for the SSH proxy node: -## License -For open source projects, say how it is licensed. + -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +--- diff --git a/build_ssh_proxy.png b/build_ssh_proxy.png new file mode 100644 index 0000000000000000000000000000000000000000..23235a97f4e9b33bd01d34f533f06c046e52b885 Binary files /dev/null and b/build_ssh_proxy.png differ diff --git a/deploy_ssh_proxy.png b/deploy_ssh_proxy.png new file mode 100644 index 0000000000000000000000000000000000000000..df041da1fbd68083752163d5ad6ab65feff04fc6 Binary files /dev/null and b/deploy_ssh_proxy.png differ