{"id":50963061,"url":"https://github.com/stackrox/roxie","last_synced_at":"2026-06-18T16:32:56.595Z","repository":{"id":358831434,"uuid":"1048480570","full_name":"stackrox/roxie","owner":"stackrox","description":"ACS Deployer Tool for Engineers","archived":false,"fork":false,"pushed_at":"2026-06-15T06:33:36.000Z","size":609,"stargazers_count":4,"open_issues_count":51,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-15T08:21:10.914Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackrox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-01T14:04:32.000Z","updated_at":"2026-06-15T06:33:33.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/stackrox/roxie","commit_stats":null,"previous_names":["stackrox/roxie"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/stackrox/roxie","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Froxie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Froxie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Froxie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Froxie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackrox","download_url":"https://codeload.github.com/stackrox/roxie/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Froxie/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34499405,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-18T16:32:55.826Z","updated_at":"2026-06-18T16:32:56.588Z","avatar_url":"https://github.com/stackrox.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"**PLEASE NOTE: This repository contains a deployment tool for ACS, which is used by\nACS engineers. It is **not** a general-purpose installation frontend for ACS or StackRox users.**\n\n# roxie – ACS deployments made easy\n\n[![Code Quality](https://github.com/stackrox/roxie/actions/workflows/code-quality.yml/badge.svg)](https://github.com/stackrox/roxie/actions/workflows/code-quality.yml)\n[![Tests](https://github.com/stackrox/roxie/actions/workflows/test.yml/badge.svg)](https://github.com/stackrox/roxie/actions/workflows/test.yml)\n\nroxie is a fast, developer-friendly CLI to deploy and manage Red Hat Advanced Cluster Security (ACS) on any Kubernetes/OpenShift cluster.\n\nroxie has been authored with significant AI contributions.\n\n## Highlights\n\n- Quick \u0026 easy ACS deployment: one command to get Central and a Secured Cluster up and running.\n- Automated waiting for readiness and loadbalancer availability.\n- No fiddling with API endpoints: detects and wires endpoints automatically.\n- No fiddling with init bundles or CRS: roxie generates and handles these bits for you.\n- Deploys the ACS Operator without requiring OpenShift/OLM.\n- Ability to replace operator versions (up- and downgrading).\n- Automated fast ACS teardowns.\n- Handles Quay image pull secrets automatically.\n- Verifies image existence before attempting deployment.\n\n## Installation\n\n### Download from GitHub releases\n\n```bash\ncurl -fsSL --retry 5 --retry-all-errors -o /usr/local/bin/roxie \\\n    https://github.com/stackrox/roxie/releases/download/v0.4.0/roxie-linux-amd64\nchmod +x /usr/local/bin/roxie\n```\n\n### Copy from container image in a Dockerfile\n\n```dockerfile\nARG ROXIE_VERSION=0.4.0\nARG ROXIE_CHECKSUM=sha256:5fe1d6d4d9c0e33385d8ca9de4baa14b4893cc5f27ddb6a3bddfe5021017fbf5\nFROM quay.io/rhacs-eng/roxie:v${ROXIE_VERSION}@${ROXIE_CHECKSUM} AS roxie-installer\n\nFROM \u003cyour-base-image\u003e\nCOPY --from=roxie-installer /usr/local/bin/roxie /usr/bin/roxie\n```\n\n## Quick start\n\n### Option 1: Deploying using image (Recommended for non-developers)\n\n**Requirements:**\n* Podman (or Docker) is set up\n* kubeconfig configuration file\n\nAnd, depending on the cluster:\n* credentials for the `quay.io` registry in the environment variables `REGISTRY_USERNAME` and `REGISTRY_PASSWORD`.\n\nInfra OpenShift4 clusters come already equipped with image pull secrets for `quay.io`, so in this case\npassing of `REGISTRY_USERNAME` and `REGISTRY_PASSWORD` to the container is not required:\n\nExample for deploying Central and SecuredCluster to an Infra OpenShift 4 cluster:\n```bash\npodman run --rm -it --privileged \\\n    -v $KUBECONFIG:/kubeconfig:U \\\n    -e MAIN_IMAGE_TAG=4.9.2 \\\n    quay.io/rhacs-eng/roxie:latest deploy --resources=auto\n```\nSpecify the `MAIN_IMAGE_TAG` as desired.\n\nDeploying to a GKE cluster requires passing of some more arguments:\n```\npodman run --rm -it --privileged \\\n    -v ~/.config/gcloud:/.config/gcloud:U \\\n    -v $KUBECONFIG:/kubeconfig:U \\\n    -e MAIN_IMAGE_TAG=4.9.2 \\\n    -e REGISTRY_USERNAME=$REGISTRY_USERNAME \\\n    -e REGISTRY_PASSWORD=$REGISTRY_PASSWORD \\\n    quay.io/rhacs-eng/roxie:latest deploy --resources=auto\n```\nNote that in this case we also need to pass the gcloud configuration for the authentication towards\nthe cluster to succeed.\n\n### Option 2: Deploying using local build\n\nPrerequisites:\n- `kubectl` configured to point at your target cluster\n- The `roxctl` CLI\n- The `roxie` branch forked and cloned to your local machine\n\nBuilt using:\n```bash\nmake build\n```\n\nGet help:\n```bash\n./roxie --help\n```\n\nDeploy using:\n```bash\nMAIN_IMAGE_TAG=4.9.2 ./roxie deploy [ \u003ccomponent\u003e ]\n```\nwhere `component` can be `central` or `sensor`. If not specified, both components will be deployed.\nSpecify the `MAIN_IMAGE_TAG` as desired.\n\nSimilarly, the deployment(s) can be torn down using:\n```bash\n./bin/roxie teardown [ \u003ccomponent\u003e ]\n```\n\n### Multi-cluster deployments\n\nroxie supports hub + spoke architectures where Central and SecuredCluster run on separate clusters.\n\n1. Deploy Central on the hub cluster:\n```bash\n./roxie deploy central -t 4.9.2\n```\n\n2. Create a config file for the spoke cluster, pointing at the Central endpoint (printed during step 1):\n```yaml\n# spoke-config.yaml\nsecuredCluster:\n  spec:\n    centralEndpoint: \"\u003ccentral-loadbalancer-ip\u003e:443\"\n```\n\n3. Switch kubectl context to the spoke cluster and deploy SecuredCluster:\n```bash\nROX_ADMIN_PASSWORD=\u003cadmin-password\u003e \\\nROX_CA_CERT_FILE=\u003cpath-to-ca-cert\u003e \\\n./roxie deploy secured-cluster -t 4.9.2 -c spoke-config.yaml\n```\n\n\u003e **Tip:** If deploying from the roxie subshell, `ROX_ADMIN_PASSWORD` and `ROX_CA_CERT_FILE` are\n\u003e already set. For automation, consider using `--envrc \u003cfile\u003e` on the Central deploy to write the\n\u003e environment to a file instead of spawning a subshell.\n\n## Development\n\nEnter the dev shell:\n```bash\nnix develop\n```\n\nCommon tasks:\n```bash\nmake fmt          # Format code (ruff)\nmake lint         # Lint (ruff)\nmake test         # Unit tests\nmake test-e2e     # E2E tests (requires a real cluster context)\n```\n\nA new roxie image for the current platform can be built using:\n\n```bash\nmake docker-build\n```\n\nThis creates two tags:\n- `localhost/roxie:latest`\n- `localhost/roxie:\u003cversion-tag\u003e`\n\nDocker images can be built for the platforms `linux/amd64` and `linux/arm64`. See the `Makefile` for more\ndocker related targets.\n\n\n## Testing (E2E)\n\nThe E2E suite expects a valid `kubectl` context.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackrox%2Froxie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackrox%2Froxie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackrox%2Froxie/lists"}