Skip to content

Commit

Permalink
docs: resource docs updates
Browse files Browse the repository at this point in the history
- make resource link better
- minor formatting fixes
- add missing settings
  • Loading branch information
redhatrises committed Apr 21, 2023
1 parent 18aa278 commit 10035b8
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 38 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ The CrowdStrike Falcon Operator deploys CrowdStrike Falcon Workload Protection t

## About Custom Resources

| Custom Resource | Description |
| :-------- | :------------ |
| [FalconContainer](docs/cluster_resources/container/README.md) | Manages installation of Falcon Container Sensor on the cluster |
| [FalconNodeSensor](docs/cluster_resources/node/README.md) | Manages installation of Falcon Linux Sensor on the cluster nodes |
| Custom Resource | Description |
| :-------- | :------------ |
| [FalconContainer](docs/resources/container/README.md) | Manages installation of Falcon Container Sensor on the cluster |
| [FalconNodeSensor](docs/resources/node/README.md) | Manages installation of Falcon Linux Sensor on the cluster nodes |

## Installation and Deployment

Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/azure/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Deployment Guide for Azure and AKS
This document will guide you through the installation of falcon-operator and deployment of either the:
- [FalconContainer](../../cluster_resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ACR (Azure Container Registry).
- [FalconNodeSensor](../../cluster_resources/node/README.md) custom resource to the cluster.
- [FalconContainer](../../resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ACR (Azure Container Registry).
- [FalconNodeSensor](../../resources/node/README.md) custom resource to the cluster.

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/eks-fargate/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deployment Guide for EKS Fargate and ECR
This document will guide you through the installation of falcon-operator and deployment of either the:
- [FalconContainer](../../cluster_resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ECR (Elastic Container Registry). A new AWS IAM Policy will be created to allow the opeator to push to ECR registry.
- [FalconContainer](../../resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ECR (Elastic Container Registry). A new AWS IAM Policy will be created to allow the opeator to push to ECR registry.

## Prerequisites

Expand Down Expand Up @@ -171,4 +171,4 @@ Using `aws`, `eksctl`, and `kubectl` command-line tools, perform the following s
- Deploy the FalconContainer resource with the IAM role changes:
```
kubectl create -f ./my-falcon-container.yaml
```
```
4 changes: 2 additions & 2 deletions docs/deployment/eks/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Deployment Guide for EKS and ECR
This document will guide you through the installation of falcon-operator and deployment of either the:
- [FalconContainer](../../cluster_resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ECR (Elastic Container Registry). A new AWS IAM Policy will be created to allow the opeator to push to ECR registry.
- [FalconNodeSensor](../../cluster_resources/node/README.md) custom resource to the cluster.
- [FalconContainer](../../resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to ECR (Elastic Container Registry). A new AWS IAM Policy will be created to allow the opeator to push to ECR registry.
- [FalconNodeSensor](../../resources/node/README.md) custom resource to the cluster.

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/gke/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Deployment Guide for GKE
This document will guide you through the installation of falcon-operator and deployment of either the:
- [FalconContainer](../../cluster_resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to GCR (Google Container Registry). A new GCP service account for pushing to GCR registry will be created.
- [FalconNodeSensor](../../cluster_resources/node/README.md) custom resource to the cluster.
- [FalconContainer](../../resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to GCR (Google Container Registry). A new GCP service account for pushing to GCR registry will be created.
- [FalconNodeSensor](../../resources/node/README.md) custom resource to the cluster.

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/openshift/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Deployment Guide for OpenShift
This document will guide you through the installation of falcon-operator and deployment of either the:
- [FalconContainer](../../cluster_resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to OpenShift ImageStreams (on cluster registry).
- [FalconNodeSensor](../../cluster_resources/node/README.md) custom resource to the cluster.
- [FalconContainer](../../resources/container/README.md) custom resource to the cluster with Falcon Container image being mirrored from CrowdStrike container registry to OpenShift ImageStreams (on cluster registry).
- [FalconNodeSensor](../../resources/node/README.md) custom resource to the cluster.

You can choose to install the operator and custom resources through the [web console (GUI)](#installing-the-operator-through-the-web-console-gui) or through the [CLI](#installing-the-operator-through-the-cli).
If you want to automate the deployment of the operator, the CLI method is recommended.
Expand Down
2 changes: 1 addition & 1 deletion docs/install_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Installation steps differ based on the Operator Life-cycle Manager (OLM) availab
operator-sdk run bundle quay.io/crowdstrike/falcon-operator-bundle:latest --namespace $OPERATOR_NAMESPACE
```

After the installation concludes, please proceed with deploying either the [Falcon Container Sensor](./cluster_resources/container/README.md) or [Falcon Node Sensor](./cluster_resources/node/README.md) Custom Resource.
After the installation concludes, please proceed with deploying either the [Falcon Container Sensor](./resources/container/README.md) or [Falcon Node Sensor](./resources/node/README.md) Custom Resource.

#### Uninstall Steps

Expand Down
Loading

0 comments on commit 10035b8

Please sign in to comment.