Skip to content

Commit a6c1afd

Browse files
committed
add docs
1 parent f89fcae commit a6c1afd

File tree

6 files changed

+196
-26
lines changed

6 files changed

+196
-26
lines changed

README.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,16 @@
1-
# kube-gateway-operator
2-
3-
![alt gopher network](https://raw.githubusercontent.com/kubevirt-ui/kube-gateway/main/web/public/network-side.png)
4-
5-
creates tokens for the [kube-gateway](https://github.com/kubevirt-ui/kube-gateway) service
6-
71
[![Go Report Card](https://goreportcard.com/badge/github.com/kubevirt-ui/kube-gateway-operator)](https://goreportcard.com/report/github.com/kubevirt-ui/kube-gateway-operator)
82
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
93

10-
## Install
11-
12-
Install using [operator-sdk](https://sdk.operatorframework.io/docs/installation/)
13-
14-
```bash
15-
# Use kube-gateway namespace
16-
oc project kube-gateway
4+
# kube-gateway-operator
175

18-
# Add privileged security context to the user running the operator
19-
oc adm policy add-scc-to-user privileged -z default -n kube-gateway
6+
![alt gopher network](https://raw.githubusercontent.com/kubevirt-ui/kube-gateway/main/docs/network-side.png)
207

21-
# Add the private key secret used to generate tokens
22-
oc create -n kube-gateway-operator-system secret generic kube-gateway-jwt-secret --from-file=test/cert.pem --from-file=test/key.pem
8+
kube-gateway-operator installs and operate [kube-gateway](https://github.com/kubevirt-ui/kube-gateway)
9+
## Build
2310

24-
# Install the operator
25-
operator-sdk run bundle quay.io/kubevirt-ui/kube-gateway-operator-bundle:v0.0.1 -n kube-gateway
11+
```bash
2612

27-
# Un-Install
28-
operator-sdk cleanup kube-gateway-operator
13+
IMG=quay.io/kubevirt-ui/kube-gateway-operator make podman-build
2914
```
3015

3116
## Usage
File renamed without changes.
File renamed without changes.

controllers/gateserver_controller.go

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,22 @@ type GateServerReconciler struct {
4242
Scheme *runtime.Scheme
4343
}
4444

45-
// +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch
46-
// +kubebuilder:rbac:groups=security.openshift.io,resources=securitycontextconstraints,resourceNames=privileged,verbs=use
47-
// +kubebuilder:rbac:groups=kubegateway.kubevirt.io,resources=gateservers,verbs=get;list;watch;create;update;patch;delete
48-
// +kubebuilder:rbac:groups=kubegateway.kubevirt.io,resources=gateservers/status,verbs=get;update;patch
49-
// +kubebuilder:rbac:groups=kubegateway.kubevirt.io,resources=gateservers/finalizers,verbs=update
45+
// +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
46+
// +kubebuilder:rbac:groups="",resources=services,verbs=get;list;watch;create;update;patch;delete
47+
// +kubebuilder:rbac:groups="",resources=serviceaccounts,verbs=get;list;watch;create;update;patch;delete
48+
// +kubebuilder:rbac:groups="apps",resources=deployments,verbs=get;list;watch;create;update;patch;delete
49+
// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=roles,verbs=get;list;watch;create;update;patch;delete
50+
// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=clusterroles,verbs=get;list;watch;create;update;patch;delete;deletecollection
51+
// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=rolebindings,verbs=get;list;watch;create;update;patch;delete
52+
// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=clusterrolebindings,verbs=get;list;watch;create;update;patch;delete;deletecollection
53+
// +kubebuilder:rbac:groups="networking.k8s.io",resources=ingresses,verbs=get;list;watch;create;update;patch;delete
54+
// +kubebuilder:rbac:groups="route.openshift.io",resources=routes,verbs=get;list;watch;create;update;patch;delete
55+
// +kubebuilder:rbac:groups="route.openshift.io",resources=routes/custom-host,verbs=create;patch
56+
// +kubebuilder:rbac:groups="oauth.openshift.io",resources=oauthclients,verbs=get;list;watch;create;update;patch;delete
57+
// +kubebuilder:rbac:groups="security.openshift.io",resources=securitycontextconstraints,resourceNames=privileged,verbs=use
58+
// +kubebuilder:rbac:groups="ocgate.rh-fieldwork.com",resources=gateservers,verbs=get;list;watch;create;update;patch;delete
59+
// +kubebuilder:rbac:groups="ocgate.rh-fieldwork.com",resources=gateservers/status,verbs=get;update;patch
60+
// +kubebuilder:rbac:groups="ocgate.rh-fieldwork.com",resources=gateservers/finalizers,verbs=update
5061

5162
// Reconcile is part of the main kubernetes reconciliation loop which aims to
5263
// move the current state of the cluster closer to the desired state.

docs/network-side.png

11.8 KB
Loading

0 commit comments

Comments
 (0)