Skip to content

docs(container-pull): remove LTS tag verbiage #519

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-cs merged 1 commit into from
Sep 2, 2026
+7 −30
Merged

docs(container-pull): remove LTS tag verbiage #519

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
29 changes: 4 additions & 25 deletions 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 @@ -108,8 +108,6 @@ Optional Flags:
latest Latest sensor version (default)
N-1 One release prior to the latest
N-2 Two releases prior to the latest
LTS Latest LTS release
LTS-1 Previous LTS release
7.33 Latest build of version 7.33.x
7.33.0-18606 Specific sensor build
-p, --platform <SENSOR_PLATFORM> Specify sensor platform to retrieve, e.g., x86_64, aarch64
Expand Down Expand Up @@ -158,7 +156,7 @@ Help Options:
| `-s`, `--client-secret <FALCON_CLIENT_SECRET>` | `$FALCON_CLIENT_SECRET` | `None` (Required) | CrowdStrike API Client Secret |
| `-r`, `--region <FALCON_CLOUD>` | `$FALCON_CLOUD` | `us-1` (Optional) | CrowdStrike Region. <br>\**Auto-discovery is only available for [`us-1, us-2, us-3, eu-1`] regions.* |
| `-c`, `--copy <REGISTRY/NAMESPACE>` | `$COPY` | `None` (Optional) | Registry you want to copy the sensor image to. Example: `myregistry.com/mynamespace`. <br> *\*By default, the image name and tag are appended. Use `--copy-omit-image-name` and/or `--copy-custom-tag` to change that behavior.* |
| `-v`, `--version <SENSOR_VERSION>` | `$SENSOR_VERSION` | `None` (Optional) | Specify sensor version to retrieve from the registry. Accepts version strings (e.g., `7.33`, `7.33.0`) or channel keywords: `latest`, `N-1`, `N-2`, `LTS`, `LTS-1` |
| `-v`, `--version <SENSOR_VERSION>` | `$SENSOR_VERSION` | `None` (Optional) | Specify sensor version to retrieve from the registry. Accepts version strings (e.g., `7.33`, `7.33.0`) or channel keywords: `latest`, `N-1`, `N-2` |
| `-p`, `--platform <SENSOR_PLATFORM>` | `$SENSOR_PLATFORM` | `None` (Optional) | Specify sensor platform to retrieve from the registry |
| `-t`, `--type <SENSOR_TYPE>` | `$SENSOR_TYPE` | `falcon-container` (Optional) | Specify which sensor to download [`falcon-container`, `falcon-container-regional`, `falcon-sensor`, `falcon-sensor-regional`, `falcon-kac`, `falcon-kac-regional`, `falcon-snapshot`, `falcon-imageanalyzer`, `falcon-imageanalyzer-regional`, `fcs`, `falcon-jobcontroller`, `falcon-registryassessmentexecutor`] ([see more details below](#sensor-types)) |
| `--runtime` | `$CONTAINER_TOOL` | `docker` (Optional) | Use a different container runtime [docker, podman, skopeo]. **Default is Docker**. |
Expand Down Expand Up @@ -209,13 +207,8 @@ The `-v, --version` flag accepts channel keywords for policy-driven deployments
| `latest` | Latest sensor version (default) |
| `N-1` | One release prior to the latest |
| `N-2` | Two releases prior to the latest |
| `LTS` | Latest LTS release |
| `LTS-1` | Previous LTS release |

Channel keywords are case-insensitive (`n-1`, `N-1`, `lts`, `LTS` all work). N-1/N-2 step back through releases and exclude LTS tags from consideration. No additional API scopes are required — channels are resolved entirely from existing registry tag data.

> [!NOTE]
> LTS (Long Term Support) sensor release tags are not yet generally available. The `LTS` and `LTS-1` keywords are included ahead of that release and will return an error until LTS-tagged images are published to the registry.
Channel keywords are case-insensitive (`n-1` and `N-1` both work). N-1/N-2 step back through releases. No additional API scopes are required — channels are resolved entirely from existing registry tag data.

```shell
# Pull latest (default behavior)
Expand All @@ -229,17 +222,6 @@ Channel keywords are case-insensitive (`n-1`, `N-1`, `lts`, `LTS` all work). N-1
--client-secret <FALCON_CLIENT_SECRET> \
--version N-1

# Pull the latest LTS release
./falcon-container-sensor-pull.sh \
--client-id <FALCON_CLIENT_ID> \
--client-secret <FALCON_CLIENT_SECRET> \
--version LTS

# Pull the previous LTS release
./falcon-container-sensor-pull.sh \
--client-id <FALCON_CLIENT_ID> \
--client-secret <FALCON_CLIENT_SECRET> \
--version LTS-1
```

### Examples
Expand Down Expand Up @@ -300,17 +282,14 @@ Example output: `registry.crowdstrike.com/falcon-sensor/release/falcon-sensor:7.

#### Example mirroring a version channel to another registry

The following example resolves the latest LTS release and copies it to an internal registry, so downstream consumers pull from a controlled mirror.

> [!NOTE]
> LTS tags may not yet be available in the registry. See the [Version Channels](#version-channels) note above for details.
The following example resolves the N-2 release and copies it to an internal registry, so downstream consumers pull from a controlled mirror.

```shell
./falcon-container-sensor-pull.sh \
--client-id <FALCON_CLIENT_ID> \
--client-secret <FALCON_CLIENT_SECRET> \
--type falcon-sensor \
--version LTS \
--version N-2 \
--copy myregistry.com/mynamespace
```

Expand Down
8 changes: 3 additions & 5 deletions 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 @@ -29,8 +29,6 @@ Optional Flags:
latest Latest sensor version (default)
N-1 One release prior to the latest
N-2 Two releases prior to the latest
LTS Latest LTS release
LTS-1 Previous LTS release
7.33 Latest build of version 7.33.x
7.33.0-18606 Specific sensor build

Expand Down Expand Up @@ -478,7 +476,7 @@ extract_raw_tags() {
'
}

# Resolve version channel keywords (latest, N-1, N-2, LTS, LTS-1) to version prefixes
# Resolve version channel keywords to version prefixes
resolve_version_channel() {
local input="$1"
local normalized all_tags major_minor_versions lts_tags lts_versions target_version
Expand Down Expand Up @@ -947,7 +945,7 @@ if [ "${ERROR}" = "true" ]; then
die "ERROR: ${CONTAINER_TOOL} login failed. Error message: ${error_message}"
fi

# Resolve channel keywords (latest, N-1, N-2, LTS, LTS-1) to version prefixes.
# Resolve channel keywords to version prefixes.
RESOLVED_VERSION=$(resolve_version_channel "$SENSOR_VERSION")

# Get latest sensor version
Expand All @@ -963,7 +961,7 @@ if [ -z "$LATESTSENSOR" ]; then
Available versions can be listed with: $0 --list-tags -t ${SENSOR_TYPE}

Tips for version matching:
- Use channel keywords: -v latest, -v N-1, -v N-2, -v LTS, -v LTS-1
- Use channel keywords: -v latest, -v N-1, -v N-2
- Use exact version: -v 7.31.0
- Use partial version: -v 7.31 (matches latest 7.31.x)
- Use major version: -v 7 (matches latest 7.x.x)
Expand Down
Loading