Skip to content

Commit

Permalink
support additional registry types and bug fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mcrowson committed Dec 5, 2024
1 parent 743560f commit 9fe4896
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 9 deletions.
75 changes: 70 additions & 5 deletions helm-charts/falcon-self-hosted-registry-assessment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ These costs may or may not be offset by the savings for data egress costs incurr
## Supported registries

* Amazon Elastic Container Registry (AWS ECR)
* Azure Container Registry
* Docker Hub
* Docker Registry V2
* GitHub
* GitLab
* Google Artifact Registry (GAR)
* Google Container Registry (GCR)
Expand All @@ -50,6 +52,7 @@ These costs may or may not be offset by the savings for data egress costs incurr
* JFrog Artifactory
* Mirantis Secure Registry (MSR)
* Oracle Container Registry
* Red Hat OpenShift
* Red Hat Quay.io
* Sonatype Nexus

Expand Down Expand Up @@ -437,16 +440,19 @@ When multiple registries are configured, jobs are scheduled round robin to balan
Find your registry type(s) in the sections below for configuration instructions, including authentication requirements and any additional required fields.

* [Amazon Elastic Container Registry (AWS ECR)](#amazon-elastic-container-registry-aws-ecr)
* [Azure Container Registry](#azure-container-registry)
* [Docker Hub](#docker-hub)
* [Docker Registry V2](#docker-registry-v2)
* [GitLab](#gitlab)
* [Github](#github)
* [Google Artifact Registry](#google-artifact-registry-gar)
* [Google Container Registry](#google-container-registry-gcr)
* [Harbor](#harbor)
* [IBM Cloud Registry](#ibm-cloud-registry)
* [JFrog Artifactory](#jfrog-artifactory)
* [Mirantis Secure Registry (MCR)](#mirantis-secure-registry-mcr)
* [Oracle Container Registry](#oracle-container-registry)
* [Red Hat Openshift](#red-hat-openshift)
* [Red Hat Quay.io](#red-hat-quayio)
* [Sonatype Nexus](#sonatype-nexus)

Expand Down Expand Up @@ -479,6 +485,22 @@ Notes:
```
Continue to add additional registries, or proceed to [Validate your registry credentials locally](#validate-the-credentials-locally).

#### Azure Container Registry

Copy this registry configuration to your `values_override.yaml` file and provide the required information.

```yaml
- type: acr
credentials:
username: ""
password: ""
allowedRepositories: ""
port: "443"
host: ""
cronSchedule: "0 0 * * *"
```
Continue to add additional registries, or proceed to [Validate your registry credentials locally](#validate-the-credentials-locally).

#### Docker Hub

Copy this registry configuration to your `values_override.yaml` file and provide the required information.
Expand Down Expand Up @@ -510,7 +532,26 @@ Copy this registry configuration to your `values_override.yaml` file and provide
```
Continue to add additional registries, or proceed to [Validate your registry credentials locally](#validate-the-credentials-locally).

#### Gitlab
#### GitHub

Copy this registry configuration to your `values_override.yaml` file and provide the required information.

* `domain_url` and `host` should both be the fully qualified domain name of your Githab installation. The values provided in the example below are for Github cloud.

```yaml
- type: github
credentials:
username: ""
domain_url: "https://api.github.com"
password: ""
allowedRepositories: ""
port: "443"
host: "https://ghcr.io"
cronSchedule: "0 0 * * *"
```
Continue to add additional registries, or proceed to [Validate your registry credentials locally](#validate-the-credentials-locally).

#### GitLab

Copy this registry configuration to your `values_override.yaml` file and provide the required information.

Expand Down Expand Up @@ -708,6 +749,22 @@ Hover over the **OICD** column to copy the compartment ID that you want to regis
```
Continue to add additional registries, or proceed to [Validate your registry credentials locally](#validate-the-credentials-locally).

#### Red Hat OpenShift

Copy this registry configuration to your `values_override.yaml` file and provide the required information.

```yaml
- type: openshift
credentials:
username: ""
password: ""
allowedRepositories: ""
port: ""
host: ""
cronSchedule: "* * * * *"
```
Continue to add additional registries, or proceed to [Validate your registry credentials locally](#validate-the-credentials-locally).

#### Red Hat Quay.io
Copy this registry configuration to your `values_override.yaml` file and provide the required information.

Expand Down Expand Up @@ -1038,9 +1095,16 @@ To increase or decrease the number of Executor Pods, edit the `executor.replicaC

### Allow traffic to CrowdStrike servers

SHRA requires internet access to your assigned CrowdStrike upload servers.
If your network requires it, configure your allow lists with your assigned CrowdStrike cloud servers.
For more info, see [CrowdStrike domains and IP addresses to allow](https://falcon.crowdstrike.com/documentation/page/a2a7fc0e/crowdstrike-oauth2-based-apis#e590c681).
SHRA requires internet access to your assigned CrowdStrike authenication API and upload servers.
If your network requires it, configure your allow lists with your assigned CrowdStrike cloud servers.

| Region | Authentication API | Upload Servers |
|:----:|:--:|:--:|
| US-1 | https://api.crowdstrike.com | https://container-upload.us-1.crowdstrike.com |
| US-2 | https://api.us-2.crowdstrike.com | https://container-upload.us-2.crowdstrike.com |
| EU-1 | https://api.eu-1.crowdstrike.com | https://container-upload.eu-1.crowdstrike.com |
| US-GOV-1 | https://api.laggar.gcw.crowdstrike.com | https://container-upload.laggar.gcw.crowdstrike.com |
| US-GOV-2 | https://api.us-gov-2.crowdstrike.mil | https://container-upload.us-gov-2.crowdstrike.mil |

### Optional. Configure CrowdStrike allow list

Expand Down Expand Up @@ -1278,6 +1342,7 @@ Before you install, follow the configuration steps above to prepare your account
helm upgrade --install -f </path/to/values_override.yaml> \
--create-namespace \
--namespace falcon-self-hosted-registry-assessment \
--wait \
falcon-shra \
crowdstrike/falcon-self-hosted-registry-assessment
```
Expand All @@ -1303,7 +1368,7 @@ After making changes to your `values_override.yaml` file, use the `helm upgrade`

To uninstall, run the following command:
```sh
helm uninstall falcon-self-hosted-registry-assessment --namespace falcon-self-hosted-registry-assessment \
helm uninstall falcon-shra --namespace falcon-self-hosted-registry-assessment \
&& kubectl delete namespace falcon-self-hosted-registry-assessment
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ spec:
value: "/storage"
- name: SQLITE_DBPATH
value: "/db"
- name: "ENVIRONMENT"
value: {{ .Values.crowdstrikeConfig.environment }}
- name: "REGION"
value: {{ .Values.crowdstrikeConfig.region }}
- name: "CLIENT_ID"
value: {{ .Values.crowdstrikeConfig.clientID }}
- name: "CLIENT_SECRET"
Expand Down Expand Up @@ -103,8 +103,8 @@ spec:
value: "/storage"
- name: SQLITE_DBPATH
value: "/db"
- name: "ENVIRONMENT"
value: {{ .Values.crowdstrikeConfig.environment }}
- name: "REGION"
value: {{ .Values.crowdstrikeConfig.region }}
- name: "CLIENT_ID"
value: {{ .Values.crowdstrikeConfig.clientID }}
- name: "CLIENT_SECRET"
Expand All @@ -113,6 +113,8 @@ spec:
value: "sqlite"
- name: "LOG_LEVEL"
value: {{ .Values.executor.logLevel | quote }}
- name: "CATALOG_PER_PAGE_RATE"
value: {{ .Values.executor.catalogPerPageRate | quote }}
{{ if (or .Values.registryConfigs .Values.executor.additionalCMEnvFrom .Values.executor.additionalSecretEnvFrom) -}}
envFrom:
{{- if .Values.registryConfigs }}
Expand Down

0 comments on commit 9fe4896

Please sign in to comment.