OpenShift prescriptive docs #409
Conversation
|
@redhatrises PTAL |
docs/deployment/openshift/README.md
Outdated
|
|
||
|  | ||
| - A Falcon Cloud Security for Containers subscription (previously known as Cloud Workload Protection) | ||
| - Red Hat Openshift 4.10+ with `cluster-admin` privileges: |
There was a problem hiding this comment.
If we can drop the OpenShift version, that would be great as it is one less item to remember to update with documentation.
There was a problem hiding this comment.
Dropped minor version and left it at OpenShift 4. 4.10 is EOL anyway so we currently work on all supported versions.
docs/deployment/openshift/README.md
Outdated
|
|
||
|  | ||
| 1. Navigate to _API clients and keys_ ([US-1](https://falcon.crowdstrike.com/api-clients-and-keys/clients), [US-2](https://falcon.us-2.crowdstrike.com/api-clients-and-keys/clients)). |
There was a problem hiding this comment.
What about eu-1 and us-gov-1? Also would prefer either making this generic for the falcon urls or dropping them altogether.
There was a problem hiding this comment.
Dropped URL's in favor of "Log in to Falcon console".
| @@ -1,83 +1,84 @@ | |||
| # Deployment Guide for OpenShift | |||
| This document will guide you through the installation of falcon-operator and deployment of either the: | |||
| - [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. | |||
|
|
|||
There was a problem hiding this comment.
Please keep these in the docs... especially since the operator links here for openshift-specific docs and no there is no easy way to find the CR docs.
There was a problem hiding this comment.
Currently linked from Limitations section.
| @@ -0,0 +1,24 @@ | |||
| # Deploying the Node Sensor to a custom Namespace | |||
There was a problem hiding this comment.
One thing to be aware of is that often it is easy for an SE/Cx to interact with a single doc vs multiple docs... especially when passing through email also the operator links here for documentation directly.... hence (while it may seem less than ideal) everything was done per single doc. If the docs should stay separated, having the docs that are broken out need and probably really should be linked and discoverable via the Readme doc.
There was a problem hiding this comment.
Added links:
- Container deployment guide from Limitations section
- Custom namespace guide from Deploy the sensor section
- Uninstall guide at the bottom
Is this sufficient or would you prefer to have all related configuration links (including FalconNodeSensor and FalconContainer from above) listed more prominently at the top of the doc? I don't want to confuse users who want the most straightforward install.
| @@ -0,0 +1,29 @@ | |||
| # Deployment Guide for OpenShift (FalconContainer) | |||
| @@ -0,0 +1,99 @@ | |||
|
|
|||
| # Uninstalling the Operator | |||
This change makes the OpenShift deployment guide more succinct and opinionated.