Skip to content
This repository has been archived by the owner on Nov 10, 2019. It is now read-only.

Octarine Plugin #73

Open
wants to merge 2 commits into
base: new-pipeline
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ See each plugin readme for more info and usage instructions.
| [Github Release](plugins/github-release/README.md) | Managing GitHub releases | `github` `release`|
| [Google GKE](plugins/gke/README.md) | GKE Clusters | `GKE` `codefresh`|
| [Vault](plugins/vault/README.md) | Export Vault Key/Value pairs as ENV variables | `Vault` `codefresh`|
| [Octarine](plugins/octarine/README.md) | Security Scanning for applicatoin deployed to Kubernetes | `security`|
1 change: 1 addition & 0 deletions plugins/octarine/Notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Notes.md
32 changes: 32 additions & 0 deletions plugins/octarine/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Kubernetes Object Scanning Tool
Docker image which invokes Kubernetes security scanning using Octactl

## Prerequisites:

Codefresh Subscription (Dedicated Infrastructure) - https://codefresh.io/

OctarineSec Subscription - https://www.octarinesec.com

## options

To use an ENVIRONMENT VARIABLE you need to add the variables to your Codefresh Pipeline and also to your codefresh.yaml.

Check the project [Github](https://github.com/octarinesec/validator) for a full list of config options

## codefresh.yml

Codefresh Build Step to execute OctarineSec scan.
All `${{var}}` variables must be put into Codefresh Build Parameters
codefresh.yml
```console
steps:
validate_security:
title: "Validating Security By Octarine"
image: "octarinesec/validator:latest"
environment:
- OCTARINE_ACCOUNT=<ACCOUNT>
- OCTARINE_SESSION_ID=<YOUR_SESSION_ID>
- OCTARINE_SESSION_ACCESSJWT=<YOUR ACCESS_JWT>
- OBJECT_DIR=${{CF_VOLUME_PATH}}/${{CF_REPO_NAME}}/kubernetes/
stage: "PreBuild test"
```
30 changes: 30 additions & 0 deletions plugins/octarine/plugin.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
image: octarinesec/validator
tag: latest
version: 19.1
description: Execute Kubernetes object security scan with Octarin (https://octarinesec.com)
keywords:
- security
- scan
home: https://github.com/octarinesec/validator
sources:
- https://github.com/octarinesec/validator
maintainers:
- name: Ram Akuka
email: [email protected]
icon: https://raw.githubusercontent.com/octarinesec/validator/master/images/logo_only.png
envs:
- name: OCTARINE_ACCOUNT
type: required
description: Octarine account name
- name: OCTARINE_SESSION_ID
type: required
description: Octarine session ID
- name: OCTARINE_SESSION_ACCESSJWT
type: required
description: Octarine session access JWT
- name: OBJECT_DIR
type: required
description: Directory or file path with the Kubernetes yaml files
- name: OCTAINE_POLICY
type: required
description: Octarine Policy name to use for the validate