diff --git a/README.md b/README.md index 563aa08..d4e78eb 100644 --- a/README.md +++ b/README.md @@ -16,18 +16,7 @@ k8dash is the easiest way to manage your Kubernetes cluster. Why?
-## Hacktoberfest Open Office Hours -Join us for open office hours to talk about issues, propose ideas, help review code, and more. - -| Date | Time | Register | -| ------------- |:-------------:| -----:| -| Friday, October 9 | 10AM-12PM CT | [register](https://organize.mlh.io/participants/events/5003-virtual-k8dash-office-hours) | -| Friday, October 16 | 10AM-12PM CT | [register](https://organize.mlh.io/participants/events/5006-virtual-k8dash-office-hours) | -| Friday, October 23 | 10AM-12PM CT |[register](https://organize.mlh.io/participants/events/5008-virtual-k8dash-office-hours) | -| Friday, October 30 | 10AM-12PM CT |[register](https://organize.mlh.io/participants/events/5009-virtual-k8dash-office-hours) | -
- - + # Table of Contents - [Prerequisites](#Prerequisites) @@ -51,7 +40,7 @@ Join us for open office hours to talk about issues, propose ideas, help review c + [metrics server](https://github.com/kubernetes-incubator/metrics-server) installed (optional, but strongly recommended) + A Kubernetes cluster configured for [OpenId Connect](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens) authentication (optional) -back to [Table of Contents](#table_of_content) +Back to [Table of Contents](#table_of_contents) ## Getting Started @@ -85,7 +74,7 @@ spec: servicePort: 80 ``` -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) # kubectl proxy @@ -93,7 +82,7 @@ Unfortunately, `kubectl proxy` can not be used to access k8dash. According to th > this is working as expected. "proxying" through the apiserver will not get you standard proxy behavior (preserving Authorization headers end-to-end), because the API is not being used as a standard proxy -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) # Logging in @@ -120,7 +109,7 @@ kubectl describe secret k8dash-sa-token-xxxxx Retrieve the `token` value from the secret and enter it into the login screen to access the dashboard. -back to [Table of Content](#table_of_content) +back to [Table of Contents](#table_of_contents) ## Running k8dash with OpenId Connect (oidc) @@ -154,7 +143,7 @@ Additionally, there are a few other OIDC options you can provide via environment The other option is `OIDC_METADATA`. k8dash uses the excellent [node-openid-client](https://github.com/panva/node-openid-client) module. `OIDC_METADATA` will take a json string and pass it to the `Client` constructor. Docs [here](https://github.com/panva/node-openid-client/blob/master/docs/README.md#client). For example, `OIDC_METADATA='{"token_endpoint_auth_method":"client_secret_post"}` -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) ## Running k8dash with NodePort @@ -168,7 +157,7 @@ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE k8dash NodePort 10.107.107.62 4654:32565/TCP 1m ``` -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) ## Metrics @@ -178,7 +167,7 @@ k8dash relies heavily on [metrics-server](https://github.com/kubernetes-incubato + [Running metrics-server with kubeadm](https://medium.com/@waleedkhan91/how-to-configure-metrics-server-on-kubeadm-provisioned-kubernetes-cluster-f755a2ac43a2) -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) # Development @@ -190,7 +179,7 @@ Installing and running [minikube](https://kubernetes.io/docs/tasks/tools/install Once minikube is installed, you can run it with the command `minikube start --driver=docker` + Once the cluster is up and running, create some login credentials as described [above](https://github.com/indeedeng/k8dash#logging-in) -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) ## k8dash is made up of 2 parts. The server and the client. @@ -202,7 +191,7 @@ The server is a simple express.js server that is primarily responsible for proxy During development, the server will use whatever is configured in `~/.kube/config` to connect the desired cluster. If you are using minikube, for example, you can run `kubectl config set-context minikube` to get `~/.kube/config` set up correctly. -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) ### Client @@ -210,7 +199,7 @@ The client is a React application (using TypeScript) with minimal other dependen To run the client, open a new terminal tab and navigate to the `/client` directory, run `npm i` and then `npm start`. This will open up a browser window to your local k8dash dashboard. If everything compiles correctly, it will load the site and then an error message will pop up `Unhandled Rejection (Error): Api request error: Forbidden...`. The error message has an 'X' in the top righthand corner to close that message. After you close it, you should see the UI where you can enter your token. -back to [Table of Content](#table_of_content) +Back to [Table of Contents](#table_of_contents) # License @@ -220,4 +209,4 @@ back to [Table of Content](#table_of_content) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Findeedeng%2Fk8dash.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Findeedeng%2Fk8dash?ref=badge_large) -You Have scrolled so far, lets go back to [Top](#top) +Back to [Top](#top)