Skip to content

chore: update README #13

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
merged 5 commits into from
Feb 14, 2024
Merged

chore: update README #13

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
05f980f
Update LICENSE
sreya Feb 14, 2024
0aec75d
add READMEg
sreya Feb 14, 2024
031ff42
add image
sreya Feb 14, 2024
ebea725
rename img
sreya Feb 14, 2024
733fcdc
wording
sreya Feb 14, 2024
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
Prev Previous commit
wording
  • Loading branch information
@sreya
sreya committed Feb 14, 2024
commit 733fcdcf68f7a12981311629e2cf25d2ed48e3b9
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
[![release](https://img.shields.io/github/v/tag/coder/coder-xray)](https://github.com/coder/coder-xray/pkgs/container/coder-xray)
[![license](https://img.shields.io/github/license/coder/coder-xray)](./LICENSE)

Query JFrog Artifactory XRay scan results for Coder workspaces to a Coder deployment.

- Query Artifactory for image vulnerability on workspace startup.
- Inform users when they are using a vulnerable image.

Expand Down Expand Up @@ -39,4 +37,6 @@ In order to use this service the following is required:

Kubernetes provides an [informers](https://pkg.go.dev/k8s.io/client-go/informers) API that streams pod and event data from the API server.

`coder-xray` listens for pod creation events with containers that have the `CODER_AGENT_TOKEN` environment variable set. All matching pods/containers are then queried against the provided artifactory instance and any XRay results are then pushed to the provided Coder deployment.
`coder-xray` listens for pod creation events with containers that have the `CODER_AGENT_TOKEN` environment
variable set. All matching pods/containers are then queried against the provided Artifactory instance and
any XRay results are then pushed to the provided Coder deployment.