Skip to content

Commit 3b87b45

Browse files
fix: updated docs and removed crds references
1 parent 58e19ae commit 3b87b45

File tree

18 files changed

+37
-252
lines changed

18 files changed

+37
-252
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,13 @@ To contribute code,
2828
5. Fork the project.
2929
6. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/compage && cd compage`
3030
7. kindly refer compage.md file to know the structure of the project.
31-
8. Refer [GitHub App setup](./github-app-setup.md)
32-
9. The Compage has 3 servers (subprojects) which need to be started to run the compage on local
31+
8. The Compage has 3 servers (subprojects) which need to be started to run the compage on local
3332
- core (Golang), navigate to core directory and follow its [core README](./core/README.md)
34-
- app (Nodejs), navigate to app directory and follow its [app README](./app/README.md)
33+
- app (NodeJs), navigate to app directory and follow its [app README](./app/README.md)
3534
- ui (ReactJs), navigate to ui directory and follow its [ui README](./ui/README.md)
36-
10. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
37-
11. Push commits.
38-
12. Open pull request.
35+
9. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
36+
10. Push commits.
37+
11. Open pull request.
3938
4039
## Improving the Documentation
4140
The documentation is contained within `./docs` and made with Docusaurus. See the [Docs README](./docs/README.md) for infos about developing the docs.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,6 @@ Active communication channels
164164

165165
## Quick start
166166

167-
- Register an app - Refer [GitHub App setup](./github-app-setup.md).
168167
- Follow step-by-step instructions given here [Run Compage on local](./deploy/README.md).
169168

170169
## License

app/README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,11 @@
11
# app
2-
- This component integrates the GitHub Oauth2 App for authentication.
3-
- This also uses K8s's etcd store to persist projects and users related data.
4-
- It's an Express JS based REST server and gRPC client to core component.
2+
- This is a component which connects to different git-platforms and push-pull repositories.
3+
- This also uses Cassandra or SQLite (based on configuration) databases to persist projects, gitplatforms and users related details.
4+
- It's an Express.js based REST server and gRPC client to core component.
55

66
#### How to run this component?
77
- Navigate to app directory [`cd app`] from root directory of compage
88
- Fire `npm install` to install the dependencies
9-
- Install the CRDs for projects and users (when you are running for the first time.) by firing below commands
10-
- `kubectl create ns compage`
11-
- `kubectl config set-context --current --namespace=compage`
12-
- `kubectl apply -f crds/project-crd.yaml`
13-
- `kubectl apply -f crds/user-crd.yaml`
14-
- Check if you are able to list `projects` and `users`. You should see below just after you fire above commands for the first time.
15-
```shell
16-
❯ kubectl get projects -A
17-
No resources found
18-
```
19-
and
20-
```shell
21-
❯ kubectl get users -A
22-
No resources found
23-
```
24-
- If you find some other error apart from the above one, that means the installation of CRDs didn't succeed.
259
- Run `npm run dev` command to start the express-server. This command will auto-reload the changes you make to app directory.
2610
- Kill process on port 5000
2711
```sudo kill -9 `sudo lsof -t -i:5000```

charts/compage/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ kubectl create ns compage
2323
kubectl config set-context --current --namespace=compage
2424
```
2525

26-
### Register an app on GitHub
27-
To run `Compage` (on your local or on the server), you have to first set up GitHub app.
28-
Refer [GitHub App setup](../../github-app-setup.md)
29-
3026
### Create namespace
3127
```yaml
3228
kubectl create ns compage

charts/compage/templates/configmaps/app.yaml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
1-
apiVersion: v1
2-
kind: ConfigMap
3-
metadata:
4-
name: app-github
5-
labels:
6-
{{- include "compage.app.labels" . | nindent 4 }}
7-
data:
8-
GITHUB_APP_REDIRECT_URI: {{.Values.githubApp.redirectURI}}
9-
101
---
11-
122
apiVersion: v1
133
kind: ConfigMap
144
metadata:

charts/compage/templates/configmaps/core.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ metadata:
55
labels:
66
{{- include "compage.core.labels" . | nindent 4 }}
77
data:
8-
OTEL_EXPORTER_OTLP_ENDPOINT: {{.Values.core.open-telemetry.otelExporterOtlpEndpoint}}
8+
OTEL_EXPORTER_OTLP_ENDPOINT: {{.Values.core.openTelemetry.otelExporterOtlpEndpoint}}

charts/compage/templates/configmaps/ui.yaml

Lines changed: 0 additions & 10 deletions
This file was deleted.

charts/compage/templates/crds/project-crd.yaml

Lines changed: 0 additions & 72 deletions
This file was deleted.

charts/compage/templates/crds/user-crd.yaml

Lines changed: 0 additions & 40 deletions
This file was deleted.

charts/compage/templates/deployments/app.yaml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ spec:
5858
name: app-github
5959
key: GITHUB_APP_REDIRECT_URI
6060
volumeMounts:
61-
- name: github-credentials
62-
mountPath: "/etc/github-credentials"
61+
- name: db-cassandra-credentials
62+
mountPath: "/etc/db-cassandra-credentials"
6363
readOnly: true
6464
- name: tmp-volume
6565
mountPath: /tmp
@@ -80,12 +80,18 @@ spec:
8080
volumes:
8181
- name: tmp-volume
8282
emptyDir: {}
83-
- name: github-credentials
83+
- name: db-cassandra-credentials
8484
secret:
85-
secretName: app-github-credentials
85+
secretName: db-cassandra-credentials
8686
defaultMode: 0400
8787
items:
88-
- key: GITHUB_APP_CLIENT_ID
89-
path: compage/GITHUB_APP_CLIENT_ID
90-
- key: GITHUB_APP_CLIENT_SECRET
91-
path: compage/GITHUB_APP_CLIENT_SECRET
88+
- key: CASSANDRA_CONTACT_POINTS
89+
path: compage/CASSANDRA_CONTACT_POINTS
90+
- key: CASANDRA_LOCAL_DATA_CENTER
91+
path: compage/CASANDRA_LOCAL_DATA_CENTER
92+
- key: CASANDRA_KEYSPACE
93+
path: compage/CASANDRA_KEYSPACE
94+
- key: CASSANDRA_USERNAME
95+
path: compage/CASSANDRA_USERNAME
96+
- key: CASSANDRA_PASSWORD
97+
path: compage/CASSANDRA_PASSWORD

0 commit comments

Comments
 (0)