Skip to content
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.

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

readme: updates the content #108

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 26 additions & 14 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,35 +37,47 @@ Find, analyze, and remediate vulnerabilities present in your container images.

| Regisry | Status |
|--------------|:-----------------:|
| Docker Hub | [In progress ⏳](https://github.com/shinobistack/gokakashi/issues/81) |
| Google Artifact Registry | [In progress ⏳](https://github.com/shinobistack/gokakashi/issues/82) |
| Docker Hub | ✅ [Enhancement in progress ⏳](https://github.com/shinobistack/gokakashi/issues/81) |
| Google Artifact Registry | ✅ [Enhancement in progress ⏳](https://github.com/shinobistack/gokakashi/issues/82) |
Comment on lines +40 to +41
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This renders like

image


The tick mark usually co-relates to a "done" item in my mind and the hour-glass co-relates a "in-progress" item. So better to have only one of them.

so

"In progress ⏳"

vs

"Enhancement in progress ⏳"

I would definitely vote for the shorter version: "In progress ⏳"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like these are already available. So we will do " ✔️ Available"

| GitHub Container Registry | [In progress ⏳](https://github.com/shinobistack/gokakashi/issues/83) |
| Amazon Elastic Container Registry | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/84) |
| Azure Container Registry | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/85) |

#### Image Scanners

| Scanner | Status |
|---------|:------:|
| Trivy | [In progress ⏳](https://github.com/shinobistack/gokakashi/issues/86) |
| Snyk | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/87) |
| Clair | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/88) |
| Scanner | Status |
|---------|:----------------------------------------------------------------------------------:|
| Trivy | ✅ [Enhancement in progress ⏳](https://github.com/shinobistack/gokakashi/issues/86) |
| Snyk | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/87) |
| Clair | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/88) |


## Install 🛠️
### Alerting & Notifications

### Server
| Platform | Status |
|----------|:-----------------------------------------------------------------------------:|
| Linear | ✅ Complete |
| Jira | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/105) |
| Slack | [Open for contribution](https://github.com/shinobistack/gokakashi/issues/106) |

```sh
docker run -d ghcr.io/shinobistack/gokakashi server
```

### Agent
## Install 🛠️

### Docker Compose

```sh
docker run --rm -it ghcr.io/shinobistack/gokakashi agent
wget https://raw.githubusercontent.com/shinobistack/gokakashi/refs/heads/main/docker-compose.yml
docker compose up -f

# brings up
# - a postgres DB
# - gokakashi server
# - gokakshi agent
```

Here’s how you can set up gokakashi using Docker Compose for both the server and PostgreSQL database.
Add your configuration file, e.g., [`./config/latest_config.yaml`](config/latest_config.yaml)

## Transparency & Feedback ✨
We’re excited to share gokakashi early with the community to gather feedback and improve quickly.

Expand Down
75 changes: 0 additions & 75 deletions config/config.yaml

This file was deleted.

75 changes: 75 additions & 0 deletions config/latest_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
integrations:
- name: lts-org-docker-hub
type: docker-hub
config:
username: ${DOCKER_USERNAME}
password: ${DOCKER_PASSWORD}

- name: team-project-artifact-registry
type: google-cloud-artifact-registry
config:
auth_type: serviceAccount
json_key_path: ee-service-account.json

- name: acme-linear
type: linear
config:
api_key: ${LINEAR_API_KEY}
project_id: ${LINEAR_PROJECT_UUID}
team_id: ${LINEAR_TEAM_UUID}
issue_title: ${OPTIONAL}
issue_priority: 2
issue_assignee_id: ${LINEAR_ASSIGNER_UUID}
issue_state_id: ${LINEAR_STATE_UUID_LIKE_BACKLOG-UUID_TRIAGE-UUID_ETC}
issue_due_date: ${LINEAR_ISSUE_DUE_DATE}

# API server configuration
site:
api_token: letsdoit
host: 0.0.0.0
port: 8000

database:
host: postgresdb
port: 5432
user: postgres
password: secret
name: postgres

policies:
- name: public-service-lts-scans
image:
registry: lts-org-docker-hub
name: ${REGISTERY_NAME}
tags:
- v2.36.0
- v2.34.0
- v2.30.0
- v2.33.0
- v2.35.2
trigger:
type: cron
schedule: "0 */8 * * *"
labels:
lts_version: v2.36
scanner: trivy
notify:
- to: acme-linear
when: |
report.Results.exists(r, r.Vulnerabilities.exists(v, v.Severity == 'CRITICAL'))
- name: cps-scans
image:
registry: CP-project-artifact-registry
name: gcr.io/hasura-ee/lux-api
tags:
- 2.2.10
trigger:
type: cron
schedule: "0 */8 * * *"
labels:
lts_version: v2.36
scanner: trivy
notify:
- to: acme-linear
when: |
report.Results.exists(r, r.Vulnerabilities.exists(v, v.Severity == 'HIGH' || v.Severity == 'CRITICAL'))
1 change: 0 additions & 1 deletion config/readme.md

This file was deleted.

Loading