Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit d7daad0

Browse files
author
Noah Hanjun Lee
authored
Add a new doc for Lock (#143)
* Add a new doc for lock * Fix deployment docs * Fix perm docs * Fix the version in the installation doc
1 parent 6811486 commit d7daad0

10 files changed

+35
-11
lines changed

docs/concepts/deployment.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,22 @@ Gitploy provides two types of deployment: Deploy and Rollback.
44

55
## Deploy
66

7-
Deploying is the primary feature of Gitploy. When you deploy, you have to select the environment and the `ref`: for the environment, you can choose one of the environments listed in the `deploy.yml`, and for the `ref`, you can choose one of commit, branch, and tag.
7+
Deploying is the primary feature of Gitploy. When you deploy, you have to select the environment and the reference. The environment is one of the environments defined in the configuration file (i.e., deploy.yml). And for reference, you can choose one of commit, branch, and tag.
88

9-
With approval, Gitploy waits until it matches the required approving approvals. So you have to confirm to deploy after approval.
9+
When you deploy the ref, Gitploy post the deployment to GitHub, and Github dispatch the event to external services.
10+
11+
Figure) Deploy
12+
13+
![deploy](../images/deploy.png)
1014

1115
## Rollback
1216

13-
Rollback is the best way to recover while you fix the problems. Gitploy supports the rollback, and you can choose one of the successful deployments to rollback.
17+
Rollback is the best way to recover while you fix the problems, and Gitploy supports the rollback. You can choose one of the deployed references for the environment to roll back.
18+
19+
When you roll back to the specific reference, Gitploy posts a new deployment with the reference from the rollbacked deployment. *Note that if the reference of the rollbacked deployment is a branch, Gitploy automatically references the commit SHA to avoid deploying the head of the branch.*
1420

1521
For best practice, you should lock the environment to block deploying by others until finishing to fix the problems. Gitploy provide the 'lock' feature in UI and Chatops.
1622

17-
*Note that if the ref of the selected deployment is a branch, Gitploy automatically references the commit SHA to prevent deploying the head of the branch.*
23+
Figure) Rollback
24+
25+
![rollback](../images/rollback.png)

docs/concepts/lock.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Lock
2+
3+
The worst thing that can happen is someone deploys to the same repository during an incident. The lock helps with this. We provide the locking system to block deployments that are going out to the environment.
4+
5+
You can lock the environment simply by clicking the button in the UI.
6+
7+
Figure) Lock
8+
9+
![lock](../images/lock.png)

docs/concepts/permission.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,14 @@ Here are capabilities for each permission:
1111

1212
* **Read** - Users can read all activities that happened in the repository, such as deployments, approvals. And users are also capable of responding to the approval.
1313

14-
* **Write** - Users can lock, deploy, and rollback for the `REF`.
14+
* **Write** - Users can lock, deploy, and rollback.
1515

1616
* **Admin** - Users can configures the repository, such as activating.
1717

18-
Of course, write and admin permission cover the ability of read permission.
18+
Of course, write and admin permission cover the ability of read permission.
19+
20+
## System admin
21+
22+
The permission of the system admin can manage members of Gitploy.
23+
24+
You can identify admin members by [GITPLOY_ADMIN_USERS](../references/GITPLOY_ADMIN_USERS.md).

docs/images/deploy-commit.png

-38.4 KB
Binary file not shown.

docs/images/deploy.png

25 KB
Loading

docs/images/lock.png

25.4 KB
Loading

docs/images/rollback.png

54.2 KB
Loading

docs/tasks/first-deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ In the 'Deploy' tab, you can find the deployment form. In this example, we'll de
3333

3434
Figure) Gitploy Deployment Form
3535

36-
![Deploy commit](../images/deploy-commit.png)
36+
![deploy](../images/deploy.png)
3737

3838
## Step 4: Deployment Event
3939
On the deployment page of Github, you can find the new Github deployment at the top. In production, the deployment tool should listen to the event and start to deploy. You can reference the [community](https://github.com/gitploy-io/gitploy/discussions/categories/share-pipeline) and it is sharing how to implement the whole pipeline.
4040

4141
Figure) Github deployment
4242

43-
![Github deployment](../images/github-deployment.png)
43+
![Github deployment](../images/github-deployment.png)

docs/tasks/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Required string value configures the GitHub OAuth client secret. This is used to
4141
The server is distributed as a Docker image. The image is self-contained and does not have any external dependencies. We recommend to use the last version.
4242

4343
```
44-
docker pull gitployio/gitploy:0.3
44+
docker pull gitployio/gitploy:0.1
4545
```
4646

4747
The server container can be started with the below command. The container is configured through environment variables.
@@ -58,7 +58,7 @@ docker run \
5858
--restart=always \
5959
--detach=true \
6060
--name=gitploy \
61-
gitployio/gitploy:0.3
61+
gitployio/gitploy:0.1
6262
```
6363

6464
### Kubernetes
@@ -105,7 +105,7 @@ spec:
105105
spec:
106106
containers:
107107
- name: gitploy-server
108-
image: "gitployio/gitploy:0.3"
108+
image: "gitployio/gitploy:0.1"
109109
imagePullPolicy: IfNotPresent
110110
ports:
111111
- name: http

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ nav:
1313
- "How it works": concepts/how-it-work.md
1414
- "deploy.yml": concepts/deploy.yml.md
1515
- Deployment: concepts/deployment.md
16+
- Lock: concepts/lock.md
1617
- Permission: concepts/permission.md
1718
- "Self-hosted Server": concepts/self-hosted-server.md
1819
- Chatops: concepts/chatops.md

0 commit comments

Comments
 (0)