Import docs

Author: hadar-co

Diff for: README.md

@@ -1,2 +1,41 @@
-# docs
-Datree documentation
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

Diff for: babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

Diff for: docs/built-in-rules/Deprecation/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Deprecation",
+  "className": "hide"
+}

Diff for: docs/built-in-rules/Deprecation/index.mdx

@@ -0,0 +1,13 @@
+---
+title: Deprecation
+slug: /built-in-rules/deprecation
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+import { BuiltInRulesDeprecation } from '/src/components/built-in-rules/BuiltInRulesNav.js';
+
+<nav>
+  <BuiltInRulesDeprecation />
+</nav>

Diff for: docs/built-in-rules/Deprecation/prevent-deprecated-k8s-api-116/index.mdx

@@ -0,0 +1,62 @@
+---
+title: ☑️ Prevent deprecated APIs in Kubernetes v1.16
+slug: /built-in-rules/prevent-deprecated-k8s-api-116
+---
+
+The v1.16 release stopped serving some API versions for different resource types. When a user deploys a resource with a deprecated API version, the Kubernetes engine rejects it.
+
+:::tip
+Kubernetes v1.16 is no longer (officially) supported since 2 September 2020, So if you are still running this version, consider upgrading it as soon as possible.
+:::
+
+**Targeted resources by this rule (types of **`kind`**): **NetworkPolicy / Deployment / DaemonSet / StatefulSet
+
+**Enabled by default?** True
+
+**Policy as code identifier:** K8S_DEPRECATED_APIVERSION_1.16
+
+---
+
+## This rule will fail
+
+If one of the following API versions is used
+
+- _extensions/v1beta1_
+
+- _apps/v1beta1_
+
+- _apps/v1beta2_
+
+```yaml
+apiVersion: apps/v1beta2
+kind: Deployment
+```
+
+### Rule output in the CLI
+
+```none
+$ datree test *.yaml
+
+>> File: failExample.yaml
+❌ Prevent deprecated APIs in Kubernetes v1.16 [1 occurrence]
+💡 Incorrect value for key `apiVersion` - the version you are trying to use is not supported by the Kubernetes cluster version (>=1.16)
+```
+
+---
+
+## How to fix this failure
+
+Use \*apps/v1**\* **instead of the deprecated version
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+```
+
+---
+
+## Read more
+
+- [Kubernetes docs - v1.16 deprecation guide](https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-16)
+
+- [Kubernetes blog - API deprecation in v1.16](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/)

Diff for: docs/built-in-rules/Deprecation/prevent-deprecated-k8s-api-117/index.mdx

@@ -0,0 +1,60 @@
+---
+title: ☑️ Prevent deprecated APIs in Kubernetes v1.17
+slug: /built-in-rules/prevent-deprecated-k8s-api-117
+---
+
+The v1.17 release stopped serving some API versions for different resource types. When a user deploys a resource with a deprecated API version, the Kubernetes engine rejects it.
+
+:::tip
+Kubernetes v1.17 is no longer (officially) supported since 30 January 2021, So if you are still running this version, consider upgrading it as soon as possible.
+:::
+
+**Targeted resources by this rule (types of **`kind`**): **NetworkPolicy / Deployment / DaemonSet / StatefulSet
+
+**Enabled by default?** True
+
+**Policy as code identifier:** K8S_DEPRECATED_APIVERSION_1.17
+
+---
+
+## This rule will fail
+
+If one of the following API versions is used
+
+- _kubeadm.k8s.io/v1beta1_
+
+- _rbac.authorization.k8s.io/v1alpha1_
+
+- _rbac.authorization.k8s.io/v1beta1_
+
+```yaml
+apiVersion: rbac.authorization.k8s.io/v1alpha1
+kind: ClusterRoleBinding
+```
+
+### Rule output in the CLI
+
+```none
+$ datree test *.yaml
+
+>> File: failExample.yaml
+❌ Prevent deprecated APIs in Kubernetes v1.17 [1 occurrence]
+💡 Incorrect value for key `apiVersion` - the version you are trying to use is not supported by the Kubernetes cluster version (>=1.17)
+```
+
+---
+
+## How to fix this failure
+
+Use \*v1**\* **instead of the deprecated version
+
+```yaml
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+```
+
+---
+
+## Read more
+
+- [Kubernetes docs - v1.17 release notes](https://v1-17.docs.kubernetes.io/docs/setup/release/notes/#deprecations-and-removals)

Diff for: docs/built-in-rules/Workload/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Workload",
+  "className": "hide"
+}

Diff for: docs/built-in-rules/Workload/ensure-env-label/index.mdx

@@ -0,0 +1,60 @@
+---
+title: ☑️ Ensure Deployment has a configured `env` label
+slug: /built-in-rules/ensure-env-label
+---
+
+Having an bulk operations in specific environments or for filtering Deployments according to their stage. Recommended values for this key are: _prod / staging / qa / admin / testing_.
+
+:::tip
+
+## FYI
+
+Labels' keys and values are case-sensitive!
+:::
+
+**Targeted resources by this rule (types of **`kind`**): **Deployment
+
+**Enabled by default?** False
+
+**Policy as code identifier:** DEPLOYMENT_MISSING_LABEL_ENV_VALUE
+
+---
+
+## This rule will fail
+
+If the `env` key is missing from the `labels` section
+
+```yaml
+kind: Deployment
+metadata:
+  labels:
+    owner: yoda-at-datree.io
+```
+
+### Rule output in the CLI
+
+```none
+$ datree test *.yaml
+
+>> File: failExample.yaml
+❌ Ensure Deployment has a configured `env` label [1 occurrence]
+💡 Missing label object `env` - add a proper environment description (e.g. `prod`, `testing`, etc.) to the Deployment config
+```
+
+---
+
+## How to fix this failure
+
+```yaml
+kind: Deployment
+metadata:
+  labels:
+    env: prod
+    owner: yoda-at-datree.io
+```
+
+---
+
+## Read more
+
+- [A Kubernetes guide for labels and selectors - labels use cases](https://www.datree.io/resources/a-kubernetes-guide-for-labels-and-selectors#anchor5)

Diff for: docs/built-in-rules/Workload/ensure-labels-value-valid/index.mdx

@@ -0,0 +1,59 @@
+---
+title: ☑️ Ensure workload has valid label values
+slug: /built-in-rules/ensure-labels-value-valid
+---
+
+Labels are nothing more than custom key-value pairs that are attached to objects and are used to describe and manage different Kubernetes resources. If the labels do not follow Kubernetes label syntax requirements (see links below), they will not be applied properly.
+
+:::tip
+
+## FYI
+
+Labels' keys and values are case-sensitive!
+:::
+
+**Targeted resources by this rule (types of **`kind`**): **Deployment / Pod / DaemonSet / StatefulSet / ReplicaSet / CronJob / Job
+
+**Enabled by default?** True
+
+**Policy as code identifier:** WORKLOAD_INVALID_LABELS_VALUE
+
+---
+
+## This rule will fail
+
+If one of the keys under `labels` contains an invalid value
+
+```yaml
+metadata:
+  labels:
+    on-call: [email protected]
+```
+
+### Rule output in the CLI
+
+```none
+$ datree test *.yaml
+
+>> File: failExample.yaml
+❌ Ensure workload has valid label values [1 occurrence]
+💡 Incorrect value for key(s) under `labels` - the vales syntax is not valid so the Kubernetes engine will not accept it
+```
+
+---
+
+## How to fix this failure
+
+```yaml
+metadata:
+  labels:
+    on-call: yoda-at-datree.io
+```
+
+---
+
+## Read more
+
+- [Kubernetes docs - labels syntax](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)
+
+- [A Kubernetes guide for labels](https://datree-io.webflow.io/resources/a-kubernetes-guide-for-labels-and-selectors#anchor10)

Diff for: docs/built-in-rules/Workload/ensure-minimum-two-replicas/index.mdx

@@ -0,0 +1,52 @@
+---
+title: ☑️ Ensure Deployment has more than one replica configured
+slug: /built-in-rules/ensure-minimum-two-replicas
+---
+
+When you run two or more replicas per service, you are increasing the availability of the containerized service because you are not relying on a single pod to do all of the work. Furthermore, scaling horizontally by adding pods allows your service to scale and handle larger loads.
+
+**Targeted resources by this rule (types of **`kind`**): **Deployment
+
+**Enabled by default?** True
+
+**Policy as code identifier:** DEPLOYMENT_INCORRECT_REPLICAS_VALUE
+
+---
+
+## This rule will fail
+
+If the number of `replicas` is set to 1
+
+```yaml
+kind: Deployment
+spec:
+  replicas: 1
+```
+
+### Rule output in the CLI
+
+```none
+$ datree test *.yaml
+
+>> File: failExample.yaml
+❌ Ensure Deployment has more than one replica configured [1 occurrence]
+💡 Incorrect value for key `replicas` - running 2 or more replicas will increase the availability of the service
+```
+
+---
+
+## How to fix this failure
+
+Set numbers of `replicas` to be greater than 1
+
+```yaml
+kind: Deployment
+spec:
+  replicas: 2
+```
+
+---
+
+## Read more
+
+- [Node management - replicas](https://cloudmark.github.io/Node-Management-In-GKE/#replicas)