Giter Club home page Giter Club logo

report-action's Introduction

report-action

Github actions to trigger report generation for runtime security.

Learn More

Inputs

inputs:
  baseline-report-path:
    description: 'baseline report path'
    required: true
    default: "baseline/report.json"

  labels:
    description: 'labels. possible value: kubearmor-app: kubearmor-relay'
    required: false
    default: ""

  operation:
    description: 'operation. possible values: process, file, network, syscall'
    required: false
    default: ""

  container-name:
    description: 'container name'
    required: false
    default: ""

  namespaces:
    description: 'namespaces'
    required: false
    default: ""

  workloads:
    description: 'workloads. possible values: deployment/mysql, statefulsets/vault, deployment/*'
    required: false
    default: ""

  source:
    description: 'source'
    required: false
    default: ""

  process-ignore-paths:
    description: 'process ignore paths. possible value: /sbin '
    required: false
    default: ""

  file-ignore-paths:
    description: 'file ignore paths. possible value: /sbin '
    required: false
    default: ""

  ignore-return-code:
    description: 'ignore return code. possible values: true/false'
    required: false
    default: ""

  view:
    description: 'view type. possible value: tabular'
    required: false
    default: "tabular"

Usage

Steps for using install-action in a workflow yaml file

  • Checkout into the repo using checkout action.
  • Set up a k8's cluster.
  • Use accuknox-install action to install Kubearmor and Discovery Engine.
  • Use accuknox-report action to generate report using Kubearmor and Discovery Engine.

Generate report at specific path

- name: accuknox-report
  uses: accuknox/[email protected]
  with:
    baseline-report-path: "baseline/report.json"
             

Sample Configuration

name: learn-accuknox-report-action
on:
  pull_request:
    branches: [main]
    types: [opened, synchronize, reopened]
  push:
    branches: [main]
jobs:
  check-working:
    runs-on: ubuntu-latest
    steps:
        - name: Checkout repo
          uses: actions/checkout@v3
          with:
            submodules: true
            
        - name: Checkout kubearmor repo
          uses: actions/checkout@v3
          with:
            repository: kubearmor/KubeArmor
            ref: main
            path: Kubearmor
  
        - name: Setup a Kubernetes environment
          run: |
            ./Kubearmor/contribution/k3s/install_k3s.sh
             sudo apt install socat
        
        - name: Install accuknoxcli, KubeArmor and Discovery Engine
          uses: accuknox/[email protected] 
 
        - name: Generate Report
          uses: accuknox/[email protected]

report-action's People

Contributors

rajasahil avatar sharmayajush avatar

Stargazers

Rahul Jadhav avatar swarit avatar  avatar  avatar Rohit Rishi M avatar

Watchers

Rahul Jadhav avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.