diff --git a/README.md b/README.md new file mode 100644 index 0000000..e2b5398 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Okta Oauth Web application + +## Getting Started + +1. Update the `config/default/deployment.yaml` to specify the following environment variables + - `CLIENT_ID` : OKTA Oauth client ID + - `CLIENT_SECRET`: OKTA Oauth client secert + - `ORG_URL`: OKTA Developer orginazation URL (e.g. dev-xxxxxxxx.okta.com) + - `KUBE_CA` : Kubernetes CA certificate. + - `KUBE_APISERVER`: Kubernetes API server endpoint. + +2. Update the `IMG` argument value in Makefile to specify the docker image URL (e.g. "/okta-oauth:latest") + +3. Update the `newName` and `newTag` in `config/default/kustomization.yaml` to match the image URL specified in step 2. + +## How to build +- Build: `make build` +- Run: `make run` +- Build docker image: `make docker-build` +- Push docker image: `make docker-push` +- Deploy this application to Kubernetes cluster: `make deploy` (Make sure the kubeconfig file is existed in `~/.kube/config`) +- Undeploy this application to Kubernetes cluster: `make undeploy` (Make sure the kubeconfig file is existed in `~/.kube/config`) +- CICD(all steps): `make all` + +## Demo URL +`https://kubernetes.jerxie.com/demo/okta-oauth/authentication/login` + +Username: `invalid.account@gmail.com` +Password: `Pa$$w0rd` \ No newline at end of file