Change name and paths to rally

This commit is contained in:
Zack Koppert 2020-06-17 15:25:22 -07:00 коммит произвёл GitHub
Родитель f42fb19561
Коммит cbf575df4d
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 12 добавлений и 12 удалений

Просмотреть файл

@ -1,17 +1,17 @@
# Docker Deployment Guide
This document will help outline the steps needed to deploy the **Probot Rally** **GitHub App** as a **Docker** container in your environment. This method should allow for multiple automations and ease of use.
This document will help outline the steps needed to deploy the **Rally + GitHub** **GitHub App** as a **Docker** container in your environment. This method should allow for multiple automations and ease of use.
## How to Deploy
### Create GitHub App on GitHub
You can find all the steps to create the GitHub app from the [README](https://github.com/github/probot-rally/blob/master/.github/README.md) on the root of the source code. You will need the **endpoints**, and `.pem` created to be able to deploy the **GitHub App**.
You can find all the steps to create the GitHub app from the [README](https://github.com/github/rally/blob/master/.github/README.md) on the root of the source code. You will need the **endpoints**, and `.pem` created to be able to deploy the **GitHub App**.
### Prepare the source code
You will first need to clone the source code to your local environment that will run the **Docker** container.
- Clone the codebase
- `git clone https://github.com/github/probot-rally.git`
- `git clone https://github.com/github/rally.git`
- Change directory to inside the code base
- `cd probot-rally/`
- `cd rally/`
- Create `.env` from `.env.example`
- `cp .env.example .env`
- Update the `.env` with thew needed fields, such as:
@ -24,16 +24,16 @@ You will first need to clone the source code to your local environment that will
- `RALLY_PORT` - If not using the standard HTTP/HTTPS ports (can be configured in the YAML)
- `RALLY_PROTOCOL` - Whether to use `http` or `https`... useful for testing in Dev (can be configured in the YAML)
You will need to copy the contents of the `.pem` created from **GitHub** to the location: `/opt/probot-rally/.ssh/probot-rally.pem`. This will be used when the container is built and deployed.
You will need to copy the contents of the `.pem` created from **GitHub** to the location: `/opt/rally/.ssh/rally.pem`. This will be used when the container is built and deployed.
Once you have the `.env` file configured, you are ready to start the building of the container.
### Build the Docker container
Once you have configured the **GitHub App** and updated the source code, you should be ready to build the container.
- Change directory to inside the code base
- `cd probot-rally/`
- `cd rally/`
- Build the container
- `sudo docker build -t probot-rally .`
- `sudo docker build -t rally .`
- This process should complete successfully and you will then have a **Docker** container ready for deployment
### Run the Docker container
@ -41,22 +41,22 @@ Once the container has been successfully built, you can deploy it and start util
#### Start the container with docker-compose
If you have docker-compose installed, you can simply start and stop the **Docker** container with:
- `cd probot-rally/; docker-compose up -d`
- `cd rally/; docker-compose up -d`
This will start the container in the background and detached.
#### Start Docker container Detached in background
- Start the container detached with port assigned (*Assuming port 3000 for the webhook*)
- `sudo docker run -d -p 3000:3000 probot-rally`
- `sudo docker run -d -p 3000:3000 rally`
- You should now have the container running in the background and can validate it running with the command:
- `sudo docker ps`
- This should show the `probot-rally` alive and running
- This should show the `rally` alive and running
#### Start Docker container attached in forground (Debug)
- If you need to run the container in interactive mode to validate connectivity and functionality:
- `sudo docker run -it -p 3000:3000 probot-rally`
- `sudo docker run -it -p 3000:3000 rally`
- You will now have the log of the container showing to your terminal, and can validate connectivity and functionality.
#### Connect to running Docker container (Debug)
- If you need to connect to the container thats already running, you can run the following command:
- `sudo docker exec -it probot-rally /bin/sh`
- `sudo docker exec -it rally /bin/sh`
- You will now be inside the running **Docker** container and can perform any troubleshooting needed