readme

Author: yaacov

README.md

@@ -6,54 +6,27 @@
 ![alt gopher network](https://raw.githubusercontent.com/kubevirt-ui/kube-gateway/main/docs/network-side.png)
 
 kube-gateway-operator installs and operate [kube-gateway](https://github.com/kubevirt-ui/kube-gateway)
-## Build
 
-```bash
+## Build and push images
 
-IMG=quay.io/kubevirt-ui/kube-gateway-operator make podman-build
+```bash
+export USERNAME=yaacov
+IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1 make podman-build
+IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1 make podman-push
 ```
 
-## Usage
-
-Requesting a token for [kube-gateway](https://github.com/kubevirt-ui/kube-gateway) service is done using GateToken CRD,
-
-Available fields are:
-
-- user-id: string (required), user-id is the user id of the user requesting this token.
-- match-path: string (required), match-path is a regular expresion used to validate API request path, API requests matching this pattern will be validated by the token. This field may not be empty.
-- match-method: string, a comma separeted list of allowed http methods, defoult is "GET,OPTIONS"
-- duration-sec: int, duration-sec is the duration in sec the token will be validated since it's invocation. Defalut value is 3600s (1h).
-- from: string, from is time of token invocation, the token will not validate before this time, the token duration will start from this time. Defalut to token object creation time.
-
-Creating a token requires a secret holding a RSA private-key for sighing the token in the namespace of the token (secret name: kube-gateway-jwt-secret), nce token is ready it will be available in the GateToken status.
-
-Get a token:
-
-[![asciicast](https://asciinema.org/a/397136.svg)](https://asciinema.org/a/397136)
-
-Deploy:
-
-[![asciicast](https://asciinema.org/a/397137.svg)](https://asciinema.org/a/397137)
-
-(gopher network image - [egonelbre/gophers](https://github.com/egonelbre/gophers))
-
 ## Deploy
 
-Requires
-
-- requires GOLANG ver >= v1.15 dev env.
-- user with admin permisions logged into the cluster.
-
 ```bash
 # Deploy the operator, RBAC roles and CRDs
 export USERNAME=yaacov
-make deploy IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1
+IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1 make deploy
 ```
 
 ```bash
 # Remove deployment of the operator, RBAC roles and CRDs
 export USERNAME=yaacov
-make undeploy IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1
+IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1 make undeploy
 ```
 
 ## Create GateToken CR
@@ -62,19 +35,19 @@ Requires a secret with private key on 'kube-gateway' namespace:
 
 ```bash
 # Use the kube-gateway namespace
-oc project kube-gateway
+oc create namespace kube-gateway
 
-# create a secret
-oc create -n kube-gateway-operator-system secret generic kube-gateway-jwt-secret --from-file=test/cert.pem --from-file=test/key.pem
+# create a sample gateway server
+oc create -f config/samples/kubegateway_v1beta1_gateserver.yaml
 
-# create a token request
+# create a sample token request
 oc create -f config/samples/kubegateway_v1beta1_gatetoken.yaml
 
 # check the token
 oc get gatetoken gatetoken-sample -o yaml
 ```
 
-## Build
+## Local dev build
 
 ```bash
 # Compile operator
@@ -88,9 +61,4 @@ make install
 make run
 ```
 
-## Build images
-
-```bash
-export USERNAME=yaacov
-make podman-build podman-push IMG=quay.io/$USERNAME/kube-gateway-operator:v0.0.1
-```
+(gopher network image - [egonelbre/gophers](https://github.com/egonelbre/gophers))