{"id":28410006,"url":"https://github.com/crowdstrike/falcon-openshift-console-plugin","last_synced_at":"2026-02-16T06:33:32.716Z","repository":{"id":255565570,"uuid":"826458901","full_name":"CrowdStrike/falcon-openshift-console-plugin","owner":"CrowdStrike","description":"Extends the OpenShift console with data from the CrowdStrike Falcon platform.","archived":false,"fork":false,"pushed_at":"2025-08-06T20:28:08.000Z","size":3624,"stargazers_count":1,"open_issues_count":6,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-09-10T06:21:38.068Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/CrowdStrike.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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":"2024-07-09T18:42:10.000Z","updated_at":"2025-03-12T03:54:49.000Z","dependencies_parsed_at":"2025-09-10T05:03:33.913Z","dependency_job_id":null,"html_url":"https://github.com/CrowdStrike/falcon-openshift-console-plugin","commit_stats":null,"previous_names":["crowdstrike/falcon-openshift-console-plugin"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/CrowdStrike/falcon-openshift-console-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Ffalcon-openshift-console-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Ffalcon-openshift-console-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Ffalcon-openshift-console-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Ffalcon-openshift-console-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrowdStrike","download_url":"https://codeload.github.com/CrowdStrike/falcon-openshift-console-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdStrike%2Ffalcon-openshift-console-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29501915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T05:57:17.024Z","status":"ssl_error","status_checked_at":"2026-02-16T05:56:49.929Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2025-06-02T11:09:40.349Z","updated_at":"2026-02-16T06:33:32.711Z","avatar_url":"https://github.com/CrowdStrike.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo.png\" alt=\"CrowdStrike logo\" width=\"500\"/\u003e\n\u003c/p\u003e\n\n# Falcon OpenShift Console Plugin\n\n[![Docker Repository on Quay](https://quay.io/repository/crowdstrike/falcon-openshift-console-plugin/status 'Docker Repository on Quay')](https://quay.io/repository/crowdstrike/falcon-openshift-console-plugin)\n\nThis is a dynamic plugin for the Red Hat OpenShift console. The plugin provides additional visibility\nto the Falcon operator and Falcon-protected virtual machines and pods.\n\n### Extension to the VirtualMachine page\n\n![Screenshot of the virtual machine page extension.](img/screenshot-vm.png)\n\n### Extension to the Pod page\n\n![Screenshot of the pod page extension.](img/screenshot-pod.png)\n\n## Support\n\nThe Falcon OpenShift Console Plugin is an open source project, not a CrowdStrike product. As such, it carries no formal support, expressed or implied.\n\n## Deployment\n\n### Deploy the Helm chart\n\nThe Falcon OpenShift Console Plugin is available at [quay.io/crowdstrike/falcon-openshift-console-plugin](https://quay.io/crowdstrike/falcon-openshift-console-plugin).\n\nInstall the chart using the name of the plugin as the Helm release name into a new namespace or an existing namespace as specified by the `plugin_console-plugin-template` parameter by using the following command:\n\n```shell\nhelm upgrade -i  falcon-openshift-console-plugin charts/openshift-console-plugin -n falcon-openshift-console-plugin --create-namespace --set plugin.image=quay.io/crowdstrike/falcon-openshift-console-plugin:latest\n```\n\n\u003e [!NOTE]\n\u003e When defining i18n namespace, adhere `plugin__\u003cname-of-the-plugin\u003e` format. The name of the plugin should be extracted from the `consolePlugin` declaration within the [package.json](package.json) file.\n\n### Configuration\n\n1. Create a CrowdStrike API client with the following permissions:\n\n   - Alerts: Read\n   - Hosts: Read\n   - Vulnerabilities: Read\n   - Falcon Container Image: Read\n\n2. In the same namespace as virtual machine or pod workloads where you want security visibility, create a secret named `crowdstrike-api` with\n   the following fields:\n\n   - `cloud` (e.g. `us-1`)\n   - `client_id`\n   - `client_secret`\n\n\u003e [!NOTE]\n\u003e This configuration assumes any user with access to read secrets in the chosen namespace should\n\u003e have access to the API client itself, as well as the related data from the Falcon platform.\n\nIf you have multiple namespaces where you want to surface CrowdStrike security data, you will need to configure a `crowdstrike-api` secret in each.\n\n## Development\n\n[Node.js](https://nodejs.org/en/) and [yarn](https://yarnpkg.com) are required\nto build and run the example. To run OpenShift console in a container, either\n[Docker](https://www.docker.com) or [podman 3.2.0+](https://podman.io) and\n[oc](https://console.redhat.com/openshift/downloads) are required.\n\n### Option 1: Local\n\nIn one terminal window, run:\n\n1. `yarn install`\n2. `yarn run start`\n\nIn another terminal window, run:\n\n1. `oc login` (requires [oc](https://console.redhat.com/openshift/downloads) and an [OpenShift cluster](https://console.redhat.com/openshift/create))\n2. `yarn run start-console` (requires [Docker](https://www.docker.com) or [podman 3.2.0+](https://podman.io))\n\nThis will run the OpenShift console in a container connected to the cluster\nyou've logged into. The plugin HTTP server runs on port 9001 with CORS enabled.\nNavigate to \u003chttp://localhost:9000/example\u003e to see the running plugin.\n\n#### Running start-console with Apple silicon and podman\n\nIf you are using podman on a Mac with Apple silicon, `yarn run start-console`\nmight fail since it runs an amd64 image. You can workaround the problem with\n[qemu-user-static](https://github.com/multiarch/qemu-user-static) by running\nthese commands:\n\n```bash\npodman machine ssh\nsudo -i\nrpm-ostree install qemu-user-static\nsystemctl reboot\n```\n\n### Option 2: Docker + VSCode Remote Container\n\nMake sure the\n[Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)\nextension is installed. This method uses Docker Compose where one container is\nthe OpenShift console and the second container is the plugin. It requires that\nyou have access to an existing OpenShift cluster. After the initial build, the\ncached containers will help you start developing in seconds.\n\n1. Create a `dev.env` file inside the `.devcontainer` folder with the correct values for your cluster:\n\n```bash\nOC_PLUGIN_NAME=console-plugin-template\nOC_URL=https://api.example.com:6443\nOC_USER=kubeadmin\nOC_PASS=\u003cpassword\u003e\n```\n\n2. `(Ctrl+Shift+P) =\u003e Remote Containers: Open Folder in Container...`\n3. `yarn run start`\n4. Navigate to \u003chttp://localhost:9000/example\u003e\n\n## i18n\n\nThe plugin template demonstrates how you can translate messages in with [react-i18next](https://react.i18next.com/). The i18n namespace must match\nthe name of the `ConsolePlugin` resource with the `plugin__` prefix to avoid\nnaming conflicts. For example, the plugin template uses the\n`plugin__console-plugin-template` namespace. You can use the `useTranslation` hook\nwith this namespace as follows:\n\n```tsx\nconster Header: React.FC = () =\u003e {\n  const { t } = useTranslation('plugin__console-plugin-template');\n  return \u003ch1\u003e{t('Hello, World!')}\u003c/h1\u003e;\n};\n```\n\nFor labels in `console-extensions.json`, you can use the format\n`%plugin__console-plugin-template~My Label%`. Console will replace the value with\nthe message for the current language from the `plugin__console-plugin-template`\nnamespace. For example:\n\n```json\n{\n  \"type\": \"console.navigation/section\",\n  \"properties\": {\n    \"id\": \"admin-demo-section\",\n    \"perspective\": \"admin\",\n    \"name\": \"%plugin__console-plugin-template~Plugin Template%\"\n  }\n}\n```\n\nRunning `yarn i18n` updates the JSON files in the `locales` folder of the\nplugin template when adding or changing messages.\n\n## Linting\n\nThis project adds prettier, eslint, and stylelint. Linting can be run with\n`yarn run lint`.\n\nThe stylelint config disallows hex colors since these cause problems with dark\nmode (starting in OpenShift console 4.11). You should use the\n[PatternFly global CSS variables](https://patternfly-react-main.surge.sh/developer-resources/global-css-variables#global-css-variables)\nfor colors instead.\n\nThe stylelint config also disallows naked element selectors like `table` and\n`.pf-` or `.co-` prefixed classes. This prevents plugins from accidentally\noverwriting default console styles, breaking the layout of existing pages. The\nbest practice is to prefix your CSS classnames with your plugin name to avoid\nconflicts. Please don't disable these rules without understanding how they can\nbreak console styles!\n\n## Reporting\n\nSteps to generate reports\n\n1. In command prompt, navigate to root folder and execute the command `yarn run cypress-merge`\n2. Then execute command `yarn run cypress-generate`\n   The cypress-report.html file is generated and should be in (/integration-tests/screenshots) directory\n\n## References\n\n- [Console Plugin SDK README](https://github.com/openshift/console/tree/master/frontend/packages/console-dynamic-plugin-sdk)\n- [Customization Plugin Example](https://github.com/spadgett/console-customization-plugin)\n- [Dynamic Plugin Enhancement Proposal](https://github.com/openshift/enhancements/blob/master/enhancements/console/dynamic-plugins.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdstrike%2Ffalcon-openshift-console-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowdstrike%2Ffalcon-openshift-console-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdstrike%2Ffalcon-openshift-console-plugin/lists"}