You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-37Lines changed: 13 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,44 +12,9 @@ The CDAP Operator is still under active development and has not been extensively
12
12
13
13
## Quick Start
14
14
15
-
### Repository Setup
16
-
17
-
The core of this codebase has contributors both in `LiveRamp` and `cdapio` Github organisations so we have customised the Git setup to enable LiveRamp devs to pull request against an internal production branch called `lr-main` whereas `develop` tracks an upstream branch, namely `cdapio/cdap-operator/tree/develop`. This is enabled through a Github action that runs sync upstream tags and the `remote` branch every night.
18
-
19
-
### Local Git Setup
20
-
21
-
Given the repository setup we reccomend the following local git setup:
This enables a developer to develop and PR against the LiveRamp "fork" as the `origin` while the `upstream` managed by the Google CDAP team can be pulled in at any time as well. Although not strictly necessary the following can be achieved by cloning this repo and then running
Automated CI for this project runs for PR and Branch commits against `lr-main` as the base branch. CI is enabled through Google Cloud Build. Images are currently pushed to `eu.gcr.io/liveramp-eng-data-ops-dev/cdap-controller` , a container registry managed by the DataOps team. Builds off of `lr-main` are pushed with a `latest` tag whereas builds from PRs are pushed with tag `{pr_number}`. It is reccomended for production deploys a purpose built tag be used. Please see `cloudbuild.yaml` and the [cloud build triggers](https://console.cloud.google.com/cloud-build/triggers?project=liveramp-eng-data-ops-dev) config for more details on the build configuration.
41
-
42
-
### CD
43
-
44
-
CD for this repo is managed seperately through the `LiveRamp/dop-infra` repository. This is so that we can have both the `cdap-operator` and `cdap` deployments managed through a single helm configuration. They are usually deployed in conjunction.
45
-
46
-
In the future we may look to change the CI process to use a LiveRamp build tool like Jenkins but at the moment this does not add any additional value for us as the `cdap-operator` codebase does not depend on any LiveRamp artifacts.
47
-
48
-
For any PR against `lr-main` you may manually trigger a one off build by typing `/gcbrun` as a comment.
49
-
50
15
### Build and Run Locally
51
16
52
-
You can checkout the CDAP Operator source code, build and run locally. To build the CDAP Operator, you need to setup your environment for the [Go](https://golang.org/doc/install) language. Also, you should have a Kubernetes cluster running and accessible in your current `kubectl` context. This could be either a Kubernetes cluster hosted on a cloud platform like GCP GKE or on a local Minikube instance.
17
+
You can checkout the CDAP Operator source code, build and run locally. To build the CDAP Operator, you need to setup your environment for the [Go](https://golang.org/doc/install) language. Also, you should have a Kubernetes cluster
53
18
54
19
1. Checkout CDAP Operator source
55
20
```
@@ -75,7 +40,7 @@ You can checkout the CDAP Operator source code, build and run locally. To build
0 commit comments