Summary:
Section titled “Summary:”This article provides step-by-step instructions to install Phanes on a macOS computer.
Who is this KB written for?:
Section titled “Who is this KB written for?:”Service Desk
When should this KB be referenced?:
Section titled “When should this KB be referenced?:”When Phanes install is requested
Section titled “When Phanes install is requested”Overview
Section titled “Overview”This article provides step-by-step instructions to install Phanes on a macOS. This process utilizes Docker Desktop and requires several developer tools installed via Homebrew. While there is a Homebrew-based method, the official recommendation is to use Docker Desktop for the most stable experience.
Prerequisites
Section titled “Prerequisites”You will need:
-
Install Rust KB00064515
-
Install Git KB00064521
-
Install Docker KB00064524
1. Install Homebrew (if not already installed)
Section titled “1. Install Homebrew (if not already installed)”Open Terminal and run:
bash
Copy code
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
2. Install Prerequisite Software
Section titled “2. Install Prerequisite Software”In Terminal:
bash
Copy code
brew install git rust pkg-config openssl make coreutils brew install --cask docker
- Note: If
dockerhas been previously installed, ensure it’s updated.
3. Install Google Cloud SDK & kubectl
Section titled “3. Install Google Cloud SDK & kubectl”bash
Copy code
brew install --cask google-cloud-sdk brew install kubectl
Afterwards, add Google Cloud SDK to your PATH:
Add this to your ~/.zshrc (or ~/.bash_profile if using bash):
bash
Copy code
source '/usr/local/Caskroom/google-cloud-sdk/latest/google-cloud-sdk/path.zsh.inc'
Then reload your shell:
bash
Copy code
source ~/.zshrc
4. Start Docker Desktop
Section titled “4. Start Docker Desktop”-
Open Docker Desktop from your Applications folder.
-
Wait until Docker finishes starting up (the Docker icon should show as running in your menu bar).
5. Set Up GitLab SSH Access
Section titled “5. Set Up GitLab SSH Access”-
Generate SSH key if needed:
bash
Copy code
ssh-keygen -t ed25519 -C "your_email@example.com" cat ~/.ssh/id_ed25519.pub # Copy this text -
Add the public key to your GitLab account
- Add to GitHub
-
Click “New SSH key” or “Add SSH key”.
-
Set a title, e.g., “(username) laptop”.
-
Paste the copied public key into the text box.
-
Click “Add SSH key”.
6. Clone the Phanes Repository
Section titled “6. Clone the Phanes Repository”In Terminal:
bash
Copy code
git clone git@gitlab.com:creyonbio1/tools/phanes cd phanes
Section titled “git clone git@gitlab.com:creyonbio1/tools/phanes cd phanes”7. Build and Install Phanes
Section titled “7. Build and Install Phanes”bash
Copy code
make phanes make install
Section titled “make phanes make install”8. Run Phanes Setup
Section titled “8. Run Phanes Setup”Replace placeholders with your details:
bash
Copy code
phanes setup --username <USER_NAME> --email <EMAIL> --fullname <FULL_NAME>
To specify a custom data directory:
bash
Copy code
phanes setup --datapath <DIR> --username <USER_NAME> --email <EMAIL> --fullname <FULL_NAME>
Note: datapath will default to $HOME/data if not specified. It will be created if it does not exist.
9. Authenticate with Google Cloud
Section titled “9. Authenticate with Google Cloud”bash
Copy code
gcloud init gcloud auth configure-docker gcloud auth application-default login
- Choose the correct project (e.g., prj-p-shared-base-15c0) when prompted.
10. Test Phanes Installation
Section titled “10. Test Phanes Installation”Verify Phanes worked:
bash
Copy code
phanes --help