Skip to content

Commit

Permalink
docs: Add operator to the README.md (aquasecurity#201)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Liz Rice <liz@lizrice.com>
  • Loading branch information
danielpacak and lizrice authored Oct 28, 2020
1 parent 8d04158 commit 49be00f
Show file tree
Hide file tree
Showing 12 changed files with 319 additions and 122 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ on:
- '.github/ISSUE_TEMPLATE/*.md'
- '*.md'
- 'docs/**'
- 'kube/**'
- 'LICENSE'
- 'NOTICE'
pull_request:
paths-ignore:
- '.github/ISSUE_TEMPLATE/*.md'
- '*.md'
- 'docs/**'
- 'kube/**'
- 'LICENSE'
- 'NOTICE'
jobs:
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,10 @@ started with a basic development workflow. For other install modes see [Operator
2. Send the following Kubernetes objects definitions to the Kubernetes API:

```
$ kubectl apply -f deploy/kubectl/01-starboard-operator.ns.yaml \
-f deploy/kubectl/02-starboard-operator.sa.yaml \
-f deploy/kubectl/03-starboard-operator.clusterrole.yaml \
-f deploy/kubectl/04-starboard-operator.clusterrolebinding.yaml
$ kubectl apply -f deploy/static/01-starboard-operator.ns.yaml \
-f deploy/static/02-starboard-operator.sa.yaml \
-f deploy/static/03-starboard-operator.clusterrole.yaml \
-f deploy/static/04-starboard-operator.clusterrolebinding.yaml
```

This will create the `starboard-operator` namespace, and the `starboard-operator` service account. Beyond that,
Expand All @@ -193,7 +193,7 @@ started with a basic development workflow. For other install modes see [Operator
1. Create the `starboard-operator` Deployment in the `starboard-operator` namespace to run the operator's container:

```
$ kubectl apply -f deploy/kubectl/05-starboard-operator.deployment.yaml
$ kubectl apply -f deploy/static/05-starboard-operator.deployment.yaml
```

### Out of cluster
Expand Down
379 changes: 289 additions & 90 deletions README.md

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
fsGroup: 10000
containers:
- name: operator
image: docker.io/aquasec/starboard-operator:dev
image: docker.io/aquasec/starboard-operator:0.6.0
imagePullPolicy: IfNotPresent
securityContext:
privileged: false
Expand Down
48 changes: 24 additions & 24 deletions docs/images/operator/starboard-operator.excalidraw
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
},
{
"type": "text",
"version": 383,
"versionNonce": 1765198042,
"version": 406,
"versionNonce": 1557121353,
"isDeleted": false,
"id": "FGX2_Bvk5avpsDgCS45bF",
"fillStyle": "hachure",
Expand All @@ -49,7 +49,7 @@
"y": 850.61328125,
"strokeColor": "#000000",
"backgroundColor": "#82c91e",
"width": 142,
"width": 136,
"height": 25,
"seed": 233404122,
"groupIds": [
Expand All @@ -59,7 +59,7 @@
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "JobsReconciler",
"text": "JobController",
"baseline": 18,
"textAlign": "left",
"verticalAlign": "top"
Expand Down Expand Up @@ -96,8 +96,8 @@
},
{
"type": "text",
"version": 235,
"versionNonce": 623389338,
"version": 258,
"versionNonce": 1503537383,
"isDeleted": false,
"id": "rwJV3UWvKs8itEHT0bGTB",
"fillStyle": "hachure",
Expand All @@ -110,7 +110,7 @@
"y": 402.33984375,
"strokeColor": "#000000",
"backgroundColor": "#82c91e",
"width": 140,
"width": 134,
"height": 25,
"seed": 1471086598,
"groupIds": [
Expand All @@ -120,7 +120,7 @@
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "PodsReconciler",
"text": "PodController",
"baseline": 18,
"textAlign": "left",
"verticalAlign": "top"
Expand Down Expand Up @@ -1367,33 +1367,33 @@
"lastCommittedPoint": null
},
{
"id": "8GCDL4aMMcwJq0JiRiNIn",
"type": "text",
"x": 502.4280133928572,
"y": 119.63392857142856,
"width": 360,
"height": 45,
"angle": 0,
"strokeColor": "#000000",
"backgroundColor": "#fab005",
"version": 172,
"versionNonce": 1796913965,
"isDeleted": false,
"id": "8GCDL4aMMcwJq0JiRiNIn",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 502.4280133928572,
"y": 119.63392857142856,
"strokeColor": "#000000",
"backgroundColor": "#fab005",
"width": 360,
"height": 45,
"seed": 902945325,
"groupIds": [],
"strokeSharpness": "sharp",
"seed": 902945325,
"version": 172,
"versionNonce": 1796913965,
"isDeleted": false,
"boundElementIds": null,
"text": "Starboard Operator",
"boundElementIds": [],
"fontSize": 36,
"fontFamily": 1,
"text": "Starboard Operator",
"baseline": 32,
"textAlign": "left",
"verticalAlign": "top",
"baseline": 32
"verticalAlign": "top"
}
],
"appState": {
Expand Down
Binary file modified docs/images/operator/starboard-operator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/use-cases/starboard-for-devops.png
Binary file not shown.
Binary file removed docs/images/use-cases/starboard-for-enterprises.png
Binary file not shown.

0 comments on commit 49be00f

Please sign in to comment.