kubes 0.1.0 → 0.2.4

data/docs/_docs/dsl/resources/deployment.md

@@ -0,0 +1,137 @@
+---
+title: Deployment
+categories: dsl
+---
+
+DSL builds Kubernetes YAML files with a reasonable default structure.  Each part of the structure can be customized and overridden.
+
+## Basics
+
+.kubes/resources/web/deployment.rb:
+
+```ruby
+name "demo-web"
+labels(role: "web")
+namespace "default"
+replicas 2
+image "nginx"
+```
+
+Produces:
+
+.kubes/output/web/deployment.yaml:
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: demo-web
+  labels:
+    app: demo
+  namespace: default
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: demo
+  template:
+    metadata:
+      labels:
+        app: demo
+    containers:
+    - name: demo-web
+      image: nginx
+```
+
+## More Customizations
+
+You can override any of the attributes within the deployment structure. You have first-class citizen access to the DSL helpers methods like template and strategy methods that set reasonable defaults.
+
+Examples:
+
+```ruby
+spec(
+  replicas: replicas,
+  selector: {matchLabels: labels},
+  strategy: strategy,
+  template: template,
+)
+```
+
+If you only have a single container:
+
+```ruby
+container(
+  name: name,
+  image: "nginx",
+  ports: [
+    containerPort: 80
+  ]
+)
+```
+
+For multiple containers:
+
+```ruby
+containers([
+  name: name,
+  image: "nginx",
+  ports: [
+    containerPort: 80
+  ]
+])
+```
+
+Refer to the source code [syntax/deployment.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/dsl/syntax/deployment.rb) for more methods available.
+
+## DSL Methods
+
+Here's a list of more common methods:
+
+Top-level and special fields:
+
+* container
+* containers
+* matchLabels
+* maxSurge
+* maxUnavailable
+* sidecar
+* templateMetadata
+* templateSpec
+
+deployment.spec fields:
+
+* minReadySeconds
+* progressDeadlineSeconds
+* replicas
+* revisionHistoryLimit
+* selector
+* strategy
+* template
+
+deployment.spec.template.spec.containers fields:
+
+* args
+* command
+* env
+* envFrom
+* image
+* imagePullPolicy
+* lifecycle
+* livenessProbe
+* containerName
+* ports
+* readinessProbe
+* volumeDevices
+* volumeMounts
+* workingDir
+
+deployment.spec.template.spec.containers.ports fields:
+
+* containerPort
+* hostIP
+* hostPort
+* portName: Note this field doesn't match the original field name. It's more qualified.
+* protocol
+
+{% include dsl/methods.md name="deployment" %}

data/docs/_docs/dsl/resources/generic.md

@@ -0,0 +1,58 @@
+---
+title: Generic
+categories: dsl
+---
+
+The generic DSL allows you to create any Kubernetes resource kind with the Kubes DSL. It is useful for resources with no pretty Kubes DSL wrappers yet.  It still has some pretty powerful helper methods.
+
+## Example 1
+
+Here's an example of an example of a make-believe SomeKind resource.
+
+.kubes/resources/web/some_kind.rb
+
+```ruby
+name "some-kind"
+labels(role: "web")
+spec(
+  spec1: "v1"
+)
+field(:data,
+  k1: "v1",
+  k2: "v2"
+)
+```
+
+Produces:
+
+.kubes/output/web/some_kind.yaml
+
+```yaml
+data:
+  k1: v1
+  k2: v2
+kind: SomeKind
+metadata:
+  name: some-kind
+  labels:
+    role: web
+spec:
+  spec1: v1
+```
+
+## DSL Methods
+
+Here's a list of common methods:
+
+Top-level and special fields:
+
+* apiVersion
+* kind
+* metadata
+* resource
+* spec
+* annotations
+* labels
+* namespace
+
+{% include dsl/methods.md name="resource" %}

data/docs/_docs/dsl/resources/ingress.md

@@ -0,0 +1,103 @@
+---
+title: Ingress
+categories: dsl
+---
+
+## Example 1
+
+Here's an example of an ingress.
+
+.kubes/resources/web/ingress.rb
+
+```ruby
+name "demo-web-ingress"
+namespace "default"
+
+serviceName "demo-web"
+servicePort 80
+```
+
+Produces:
+
+.kubes/output/web/ingress.yaml
+
+```yaml
+---
+apiVersion: networking.k8s.io/v1beta1
+kind: Ingress
+metadata:
+  name: demo-web-ingress
+  namespace: demo
+spec:
+  rules:
+  - http:
+      paths:
+      - path: "/*"
+        backend:
+          serviceName: demo-web
+          servicePort: 80
+```
+
+## Example 2
+
+.kubes/resources/web/ingress.rb
+
+```ruby
+name "demo-web-ingress"
+
+paths([{
+  path: "/*",
+  backend: {
+    serviceName: "hello-world",
+    servicePort: 60000,
+  },
+},{
+  path: "/kube",
+  backend: {
+    serviceName: "hello-kubernetes",
+    servicePort: 80,
+  },
+}])
+```
+
+Produces:
+
+.kubes/output/web/ingress.yaml
+
+```yaml
+---
+apiVersion: networking.k8s.io/v1beta1
+kind: Ingress
+metadata:
+  name: demo-web-ingress
+spec:
+  rules:
+  - http:
+      paths:
+      - path: "/*"
+        backend:
+          serviceName: hello-world
+          servicePort: 60000
+      - path: "/kube"
+        backend:
+          serviceName: hello-kubernetes
+          servicePort: 80
+```
+
+## DSL Methods
+
+Here's a list of more common methods:
+
+Top-level and special fields:
+
+* paths
+* serviceName
+* servicePort
+
+ingress.spec fields
+
+* backend
+* rules
+* tls
+
+{% include dsl/methods.md name="ingress" %}

data/docs/_docs/dsl/resources/managed_certificate.md

@@ -0,0 +1,39 @@
+---
+title: ManagedCertificate
+categories: dsl
+---
+
+Here's an example of a ManagedCertificate.
+
+.kubes/resources/web/managed_certificate.rb
+
+```ruby
+name "cert1"
+domains(["cert1.example.com"])
+```
+
+Produces:
+
+.kubes/output/web/managed_certificate.yaml
+
+```yaml
+---
+apiVersion: networking.gke.io/v1beta2
+kind: ManagedCertificate
+metadata:
+  name: cert1
+spec:
+  domains:
+  - cert1.example.com
+```
+
+## DSL Methods
+
+Here's a list of more common methods:
+
+Top-level and special fields:
+
+* domain
+* domains
+
+{% include dsl/methods.md name="managed_certificate" %}

data/docs/_docs/dsl/resources/namespace.md

@@ -0,0 +1,34 @@
+---
+title: Namespace
+categories: dsl
+---
+
+## Example
+
+Here's an example of a Namespace.
+
+.kubes/resources/shared/namespace.rb
+
+```ruby
+name "demo"
+labels(app: "demo") # useful with NetworkPolicy
+```
+
+Produces:
+
+.kubes/output/shared/namespace.yaml
+
+```yaml
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: demo
+  labels:
+    app: demo
+```
+
+## DSL Methods
+
+Here's the source of the namespace resource.
+
+{% include dsl/methods.md name="namespace" %}

data/docs/_docs/dsl/resources/network_policy.md

@@ -0,0 +1,111 @@
+---
+title: NetworkPolicy
+categories: dsl
+---
+
+## Example
+
+Here's an example of a NetworkPolicy.
+
+.kubes/resources/web/network_policy.rb
+
+```ruby
+name "web"
+labels(app: "backend")
+namespace "backend"
+
+matchLabels(app: "backend", role: "web")
+fromNamespace(app: "frontend")
+fromPod(app: "backend")
+```
+
+Produces:
+
+.kubes/output/web/network_policy.yaml
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: web
+  labels:
+    app: backend
+  namespace: backend
+spec:
+  podSelector:
+    matchLabels:
+      app: backend
+      role: web
+  ingress:
+  - from:
+    - namespaceSelector:
+        matchLabels:
+          app: frontend
+    - podSelector:
+        matchLabels:
+          app: backend
+```
+
+Note, the behavior of the from is an *or* since the namespaceSelector and podSelector are separate items.
+
+## Example 2
+
+If you need more control over the ingress selectors, you can use the `from` method. Here's an example:
+
+.kubes/resources/web/network_policy.rb
+
+```ruby
+name "web"
+labels(app: "backend")
+namespace "backend"
+
+matchLabels(app: "backend", role: "web")
+from([
+  { namespaceSelector: { matchLabels: { app: "frontend" } } },
+  { namespaceSelector: { matchLabels: { app: "backend" } } }
+])
+```
+
+Produces:
+
+.kubes/output/web/network_policy.yaml
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: web
+  labels:
+    app: backend
+  namespace: backend
+spec:
+  podSelector:
+    matchLabels:
+      app: backend
+      role: web
+  ingress:
+  - from:
+    - namespaceSelector:
+        matchLabels:
+          app: frontend
+    - namespaceSelector:
+        matchLabels:
+          app: backend
+```
+
+This will allow traffic from pods in either the frontend or backend namespaces to the backend pods.
+
+## DSL Methods
+
+Here's a list of more common methods:
+
+* fromNamespace
+* fromPod
+* fromIpBlock
+* toNamespace
+* toPod
+* toIpBlock
+* from
+* to
+
+{% include dsl/methods.md name="network_policy" %}