Skip to content

Commit 355e4ad

Browse files
authored
Bump v1.1.0 (#146)
* Updating readmes to include new v1.1.0 release * Updating bash readme
1 parent 73a9aed commit 355e4ad

File tree

4 files changed

+65
-27
lines changed

4 files changed

+65
-27
lines changed

bash/install/README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,15 @@ environment variable.
1010
API clients are granted one or more API scopes. Scopes allow access to specific CrowdStrike APIs and describe the actions that an API client can perform.
1111

1212
Ensure the following API scopes are enabled:
13-
* **Sensor Download** [read]
14-
* **Sensor update policies** [read]
1513

16-
## Configuration
17-
18-
1. Get sensor download API credentials from the cloud where your account has been configured:
14+
- **Sensor Download** [read]
15+
- (optional) **Sensor update policies** [read]
16+
> Use this scope when configuring the `FALCON_SENSOR_UPDATE_POLICY_NAME` environment variable.
1917
20-
- https://falcon.crowdstrike.com/support/api-clients-and-keys
21-
- or https://falcon.us-2.crowdstrike.com/support/api-clients-and-keys
22-
- or https://falcon.eu-1.crowdstrike.com/support/api-clients-and-keys
18+
## Configuration
2319

24-
Configure environment variables with your API credentials. Make sure that scope **Sensor Download** [read] is enabled.
20+
**Export the required environment variables:**
2521

26-
Export the required environment variables:
2722
```bash
2823
export FALCON_CLIENT_ID="XXXXXXX"
2924
export FALCON_CLIENT_SECRET="YYYYYYYYY"
@@ -32,7 +27,8 @@ export FALCON_CLIENT_SECRET="YYYYYYYYY"
3227
The installer is AWS SSM aware, if `FALCON_CLIENT_ID` and `FALCON_CLIENT_SECRET` are not provided AND the script is running on an AWS instance, the script will try to get API credentials from the SSM store of the region.
3328

3429
Optional environment variables that can be exported:
35-
```bash
30+
31+
```terminal
3632
FALCON_CID (default: auto)
3733
FALCON_CLOUD (default: us-1)
3834
FALCON_SENSOR_VERSION_DECREMENT (default: 0 [latest])
@@ -47,12 +43,11 @@ FALCON_BILLING (default: default) possible values: [default|m
4743
FALCON_BACKEND (default: auto) possible values: [auto|bpf|kernel]
4844
FALCON_TRACE (default: none) possible values: [none|err|warn|info|debug]
4945
```
50-
The `FALCON_SENSOR_UPDATE_POLICY_NAME` variable requires to have additional API access. Make sure that scope **Sensor update policies** [read] is enabled.
5146

52-
2. Run the script:
47+
**Run the script**:
5348

5449
```bash
55-
curl -L https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.0.0/bash/install/falcon-linux-install.sh | bash
50+
curl -L https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.1.0/bash/install/falcon-linux-install.sh | bash
5651
```
5752

5853
Alternatively, you can run the script by cloning the repo:
@@ -66,7 +61,23 @@ Then, run the following command:
6661
```bash
6762
./falcon-linux-install.sh
6863
```
64+
6965
or
66+
7067
```bash
7168
bash falcon-linux-install.sh
7269
```
70+
71+
## Troubleshooting
72+
73+
To troubleshoot installation issues, run the script by using `bash -x`:
74+
75+
```bash
76+
bash -x falcon-linux-install.sh
77+
```
78+
79+
or
80+
81+
```bash
82+
curl -L https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.1.0/bash/install/falcon-linux-install.sh | bash -x
83+
```

powershell/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
| Scripts | Description |
44
|:-|:-|
55
| [Install](install) | PowerShell scripts for installing/uninstalling the CrowdStrike Falcon Sensor for Windows |
6+
| [Migrate](migrate) | PowerShell script for host migration between Falcon cloud tenants |

powershell/install/README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ Powershell scripts to install/uninstall Falcon Sensor through the Falcon APIs on
77
API clients are granted one or more API scopes. Scopes allow access to specific CrowdStrike APIs and describe the actions that an API client can perform.
88

99
Ensure the following API scopes are enabled:
10+
1011
- Install:
11-
* **Sensor Download** [read]
12-
* **Sensor update policies** [read]
12+
- **Sensor Download** [read]
13+
- **Sensor update policies** [read]
1314
- Uninstall:
14-
* **Host** [write]
15-
* **Sensor update policies** [write]
15+
- **Host** [write]
16+
- **Sensor update policies** [write]
1617

1718
## Configuration
1819

@@ -29,7 +30,7 @@ to complete.
2930
Script options can be passed as parameters or defined in the param() block. Default values are listed in
3031
the parameter descriptions:
3132

32-
```pwsh
33+
```terminal
3334
.PARAMETER FalconCloud
3435
CrowdStrike Falcon OAuth2 API Hostname ['https://api.crowdstrike.com' if left undefined]
3536
.PARAMETER FalconClientId
@@ -58,9 +59,18 @@ Time to wait, in seconds, for sensor to provision [default: 1200]
5859
A comma-separated list of tags to apply to the host after sensor installation [default: $null]
5960
```
6061

61-
Example:
62+
***Examples***:
63+
64+
To download the script:
65+
66+
```pwsh
67+
Invoke-WebRequest -Uri https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.1.0/powershell/install/falcon_windows_install.ps1 -OutFile falcon_windows_install.ps1
68+
```
69+
70+
Basic example that will install the sensor with the provided provisioning token
71+
6272
```pwsh
63-
PS>.\falcon_windows_install.ps1 -FalconClientId <string> -FalconClientSecret <string>
73+
.\falcon_windows_install.ps1 -FalconClientId <string> -FalconClientSecret <string> -ProvToken <string>
6474
```
6575

6676
### Uninstall
@@ -74,7 +84,7 @@ to complete.
7484
Script options can be passed as parameters or defined in the param() block. Default values are listed in
7585
the parameter descriptions:
7686

77-
```pwsh
87+
```terminal
7888
.PARAMETER MaintenanceToken
7989
Sensor uninstall maintenance token. If left undefined, the script will attempt to retrieve the
8090
token from the API assuming the FalconClientId|FalconClientSecret are defined.
@@ -100,15 +110,23 @@ CrowdStrike Falcon OAuth2 API Client Secret [Required if RemoveHost is $true]
100110
Member CID, used only in multi-CID ("Falcon Flight Control") configurations and with a parent management CID.
101111
```
102112

103-
Examples:
113+
***Examples***:
114+
115+
To download the script:
116+
117+
```pwsh
118+
Invoke-WebRequest -Uri https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.1.0/powershell/install/falcon_windows_uninstall.ps1 -OutFile falcon_windows_uninstall.ps1
119+
```
104120

105121
Basic example that will uninstall the sensor with the provided maintenance token
122+
106123
```pwsh
107-
PS>.\falcon_windows_uninstall.ps1 -MaintenanceToken <string>
124+
.\falcon_windows_uninstall.ps1 -MaintenanceToken <string>
108125
```
109126

110127
An example using the Falcon API to retrieve the maintenance token and remove the host from the Falcon console
111128
after uninstalling.
129+
112130
```pwsh
113-
PS>.\falcon_windows_uninstall.ps1 -FalconClientId <string> -FalconClientSecret <string> -RemoveHost $true
131+
.\falcon_windows_uninstall.ps1 -FalconClientId <string> -FalconClientSecret <string> -RemoveHost $true
114132
```

powershell/migrate/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,17 @@ Remove host from CrowdStrike Falcon
8787
Opt in/out of migrating tags. Tags passed to the Tags flag will still be added.
8888
```
8989

90+
----------
91+
92+
To download the script, run the following command:
93+
94+
```pwsh
95+
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.1.0/powershell/migrate/falcon_windows_migrate.ps1" -OutFile "falcon_windows_migrate.ps1"
96+
```
97+
9098
### Example 1
9199

92-
A simple migration from US-1 to US-2 including sensor tags and falcon tags:
100+
A simple migration from US-1 to US-2 including existing sensor and falcon tags:
93101

94102
```pwsh
95103
.\falcon_windows_migrate.ps1 `
@@ -119,7 +127,7 @@ Migrate from US-1 to EU-1, remove the old host from the UI and add a new sensor
119127

120128
### Example 3
121129

122-
Migrate from US-2 to EU-1, use a provisioning token and add a new falcon tag to the sensor:
130+
Migrate from US-2 to EU-1, use a provisioning token and add a new falcon tag:
123131

124132
```pwsh
125133
.\falcon_windows_migrate.ps1 `

0 commit comments

Comments
 (0)