Skip to content

fix: update doc strings and parameter validation to support us-gov-2 #434

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

Merged
carlosmmatos merged 2 commits into from
May 9, 2025
Merged

fix: update doc strings and parameter validation to support us-gov-2 #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c52a6e
fix: update doc strings and parameter validation to support us-gov-2
fwwieffering May 9, 2025
753d765
chore: putting usage back
carlosmmatos May 9, 2025
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
2 changes: 1 addition & 1 deletion bash/containers/falcon-container-sensor-pull/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Required Flags:

Optional Flags:
-f, --cid <FALCON_CID> Falcon Customer ID
-r, --region <FALCON_CLOUD> Falcon Cloud Region [us-1|us-2|eu-1|us-gov-1] (Default: us-1)
-r, --region <FALCON_CLOUD> Falcon Cloud Region [us-1|us-2|eu-1|us-gov-1|us-gov-2] (Default: us-1)
-c, --copy <REGISTRY/NAMESPACE> Registry to copy the image to, e.g., myregistry.com/mynamespace
By default, the image name and tag are appended. Use --copy-omit-image-name
and/or --copy-custom-tag to change that behavior.
Expand Down
2 changes: 1 addition & 1 deletion bash/containers/falcon-container-sensor-pull/falcon-container-sensor-pull.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Required Flags:

Optional Flags:
-f, --cid <FALCON_CID> Falcon Customer ID
-r, --region <FALCON_CLOUD> Falcon Cloud Region [us-1|us-2|eu-1|us-gov-1] (Default: us-1)
-r, --region <FALCON_CLOUD> Falcon Cloud Region [us-1|us-2|eu-1|us-gov-1|us-gov-2] (Default: us-1)
-c, --copy <REGISTRY/NAMESPACE> Registry to copy the image to, e.g., myregistry.com/mynamespace
By default, the image name and tag are appended. Use --copy-omit-image-name
and/or --copy-custom-tag to change that behavior.
Expand Down
13 changes: 11 additions & 2 deletions bash/install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Authentication:
- FALCON_CLOUD (default: unset)
The cloud region where your CrowdStrike Falcon instance is hosted.
Required if using FALCON_ACCESS_TOKEN.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

Other Options
- FALCON_CID (default: auto)
Expand All @@ -133,6 +133,7 @@ Other Options

- FALCON_SENSOR_VERSION_DECREMENT (default: 0 [latest])
The number of versions prior to the latest release to install.
For example, 1 would install version N-1.

- FALCON_PROVISIONING_TOKEN (default: unset)
The provisioning token to use for installing the sensor.
Expand Down Expand Up @@ -191,6 +192,10 @@ Other Options
To prepare the sensor to be used in a golden image.
Accepted values are ['true', 'false'].

- USER_AGENT (default: unset)
User agent string to append to the User-Agent header when making
requests to the CrowdStrike API.

This script recognizes the following argument:
-h, --help
Print this help message and exit.
Expand Down Expand Up @@ -273,7 +278,7 @@ Authentication:
- FALCON_CLOUD (default: unset)
The cloud region where your CrowdStrike Falcon instance is hosted.
Required if using FALCON_ACCESS_TOKEN.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

Other Options:
- FALCON_MAINTENANCE_TOKEN (default: unset)
Expand All @@ -298,6 +303,10 @@ Other Options:
- FALCON_APP (default: unset)
The proxy port for the sensor to use when communicating with CrowdStrike.

- USER_AGENT (default: unset)
User agent string to append to the User-Agent header when making
requests to the CrowdStrike API.

This script recognizes the following argument:
-h, --help
Print this help message and exit.
Expand Down
2 changes: 1 addition & 1 deletion bash/install/falcon-linux-install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Authentication:
- FALCON_CLOUD (default: unset)
The cloud region where your CrowdStrike Falcon instance is hosted.
Required if using FALCON_ACCESS_TOKEN.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

Other Options
- FALCON_CID (default: auto)
Expand Down
2 changes: 1 addition & 1 deletion bash/install/falcon-linux-uninstall.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Authentication:
- FALCON_CLOUD (default: unset)
The cloud region where your CrowdStrike Falcon instance is hosted.
Required if using FALCON_ACCESS_TOKEN.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

Other Options:
- FALCON_MAINTENANCE_TOKEN (default: unset)
Expand Down
4 changes: 2 additions & 2 deletions bash/migrate/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Old CID Authentication:

- OLD_FALCON_CLOUD (default: 'us-1')
The cloud region where your old CrowdStrike Falcon instance is hosted.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

New CID Authentication:
- NEW_FALCON_CLIENT_ID (default: unset) [Required]
Expand All @@ -116,7 +116,7 @@ New CID Authentication:

- NEW_FALCON_CLOUD (default: 'us-1')
The cloud region where your new CrowdStrike Falcon instance is hosted.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

- NEW_FALCON_CID (default: unset)
Your CrowdStrike Falcon customer ID (CID) for the new CID.
Expand Down
4 changes: 2 additions & 2 deletions bash/migrate/falcon-linux-migrate.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Old CID Authentication:

- OLD_FALCON_CLOUD (default: 'us-1')
The cloud region where your old CrowdStrike Falcon instance is hosted.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

New CID Authentication:
- NEW_FALCON_CLIENT_ID (default: unset) [Required]
Expand All @@ -43,7 +43,7 @@ New CID Authentication:

- NEW_FALCON_CLOUD (default: 'us-1')
The cloud region where your new CrowdStrike Falcon instance is hosted.
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1'].
Accepted values are ['us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2'].

- NEW_FALCON_CID (default: unset)
Your CrowdStrike Falcon customer ID (CID) for the new CID.
Expand Down
2 changes: 1 addition & 1 deletion powershell/install/falcon_windows_install.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Updated 2021-10-22 to include 'sensor_version' property when matching policy to
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'DeleteScript')]
param(
[Parameter(Position = 1)]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1')]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2')]
[string] $FalconCloud = 'autodiscover',

[Parameter(Position = 2)]
Expand Down
2 changes: 1 addition & 1 deletion powershell/install/falcon_windows_uninstall.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ param(
[switch] $RemoveHost,

[Parameter(Position = 8)]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1')]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2')]
[string] $FalconCloud = 'autodiscover',

[Parameter(Position = 9)]
Expand Down
4 changes: 2 additions & 2 deletions powershell/migrate/falcon_windows_migrate.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ param(
[ValidatePattern('\w{40}')]
[string] $NewFalconClientSecret,
[Parameter(Position = 3)]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1')]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2')]
[string] $NewFalconCloud = 'autodiscover',
[Parameter(Position = 4)]
[string] $NewMemberCid,
Expand All @@ -87,7 +87,7 @@ param(
[ValidatePattern('\w{40}')]
[string] $OldFalconClientSecret,
[Parameter(Position = 7)]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1')]
[ValidateSet('autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1', 'us-gov-2')]
[string] $OldFalconCloud = 'autodiscover',
[Parameter(Position = 8)]
[string] $OldMemberCid,
Expand Down
Loading