Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: resource docs updates #370

Merged
merged 1 commit into from
Apr 22, 2023
Merged

docs: resource docs updates #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions docs/deployment/openshift/README.md
View file
Open in desktop
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 Expand Up @@ -138,7 +138,7 @@ If you want to automate the deployment of the operator, the CLI method is recomm
startingCSV: falcon-operator.v0.6.0
EOF
```
An [example subscription of the official Red Hat Marketplace certified operator is available](https://raw.githubusercontent.com/CrowdStrike/falcon-operator/main/docs/deployment/openshift/redhat-marketplace.yaml) to use and modify as appropriate for your cluster. Make sure to update the `startingCSV: falcon-operator.v0.6.0` for the version that is listed locally on your cluster.
An [example subscription of the official Red Hat Marketplace certified operator is available](https://raw.githubusercontent.com/CrowdStrike/falcon-operator/main/docs/deployment/openshift/redhat-subscription.yaml) to use and modify as appropriate for your cluster. Make sure to update the `startingCSV: falcon-operator.v0.6.0` for the version that is listed locally on your cluster.

### Installing the Community Operator from the Console OperatorHub

Expand Down
4 changes: 2 additions & 2 deletions docs/install_guide.md
View file
Open in desktop
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 Expand Up @@ -73,7 +73,7 @@ The CrowdStrike Falcon Operator does not currently support upgrading the operato

### What network connections are required for the operator to work properly?

- The operator image is available at [quay.io/crowdstrike/falcon-operator](quay.io/crowdstrike/falcon-operator). If necessary, the operator image itself can be mirrored to your registry of choice, including internally hosted registries.
- The operator image is available at [quay.io/crowdstrike/falcon-operator](https://quay.io/crowdstrike/falcon-operator). If necessary, the operator image itself can be mirrored to your registry of choice, including internally hosted registries.
- The operator will need to be able to reach your particular Falcon cloud region (api.crowdstrike.com or api.[YOUR CLOUD].crowdstrike.com).
- The operator OR your nodes may attempt to reach to `registry.crowdstrike.com` depending on whether the image is being mirrored or not.
- If Falcon Cloud is set to autodiscover, the operator may also attempt to reach the Falcon Cloud Region **us-1**.
Expand Down
Loading