Commit 57e616e7 authored by moha-s's avatar moha-s
Browse files

Merge branch '404-new-job-kustomize_deploy' of gitlab.com:r2devops/hub into... 

Merge branch '404-new-job-kustomize_deploy' of gitlab.com:r2devops/hub into 404-new-job-kustomize_deploy
parents 6c183b71 c16a4fb1

docs/create-update-job.md

+3 −4
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ The first step is to create your own copy of [`r2devops/hub`](https://gitlab.com 
able to work on it before merging your update in the real project.



1. Go on the fork page creation: [`r2devops/hub`](https://gitlab.com/r2devops/hub/-/forks/new).

2. Select the group in which you want to create the fork.

1. Select the group in which you want to create the fork.



### 💻 Step 2: Work in your fork
@@ -42,11 +42,11 @@ able to work on it before merging your update in the real project. 
      1. Make sure that you have NPM installed, more about that [here](https://nodejs.org/en/download/){:target=blank}

      1. Install the package `Cookicutter` by executing this command:

        ```shell

         $ npm install -g cookiecutter

        npm install -g cookiecutter

        ```

      1. In the `hub` folder, run this command and input the necessary information:

        ```shell

         $ npx cookiecutter

        npx cookiecutter

        ```



    !!! info
@@ -95,7 +95,6 @@ Now, we will take a look at your work and merge it if everything is ok. 
👀 Meanwhile, you can join our [Discord community](https://discord.gg/5QKpGqR) to tell us more about your fresh new contribution.

We love talking with our contributors and users!





## Guidelines (Required)



!!! warning

jobs/super_linter/README.md

+7 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ customize its behavior. 
| **DOCKERFILE_HADOLINT_FILE_NAME** | Filename for [hadolint configuration](https://github.com/hadolint/hadolint){:target="_blank"} (ex: `.hadolintlintrc.yaml`)                                                                   | `.hadolint.yml`      |

| **ERROR_ON_MISSING_EXEC_BIT**     | If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an arror instead.| `false`              |

| **JAVASCRIPT_ES_CONFIG_FILE**     | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats){:target="_blank"} (ex: `.eslintrc.yml`, `.eslintrc.json`)                     | `.eslintrc.yml`      |

| **LINTER_RULES_PATH**             | Directory for all linter configuration rules.                                                                                                                              | `.github/linters`    |

| **LINTER_RULES_PATH**             | Directory for all linter configuration rules.                                                                                                                              | `.linters`    |

| **MARKDOWN_CONFIG_FILE**          | Filename for [Markdownlint configuration](https://github.com/DavidAnson/markdownlint#optionsconfig){:target="_blank"} (ex: `.markdown-lint.yml`, `.markdownlint.json`, `.markdownlint.yaml`) | `.markdown-lint.yml` |

| **PYTHON_PYLINT_CONFIG_FILE**     | Filename for [pylint configuration](https://pylint.pycqa.org/en/latest/user_guide/run.html?highlight=rcfile#command-line-options){:target="_blank"} (ex: `.python-lint`, `.pylintrc`)        | `.python-lint`       |

| **PYTHON_FLAKE8_CONFIG_FILE**     | Filename for [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html){:target="_blank"} (ex: `.flake8`, `tox.ini`)                                                 | `.flake8`            |
@@ -115,6 +115,12 @@ customize its behavior. 
| **TYPESCRIPT_ES_CONFIG_FILE**     | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats){:target="_blank"} (ex: `.eslintrc.yml`, `.eslintrc.json`)                     | `.eslintrc.yml`      |

| **YAML_CONFIG_FILE**              | Filename for [Yamllint configuration](https://yamllint.readthedocs.io/en/stable/configuration.html){:target="_blank"} (ex: `.yaml-lint.yml`, `.yamllint.yml`)                                | `.yaml-lint.yml`     |



!!! warning

    Please be aware that any config file specified is relative to `$LINTER_RULES_PATH`, so you have to put **all your

    templating** under the path specified. If you are curious to know what are the *default templates* files for your

    linters, they are all available in the [`TEMPLATES`](https://github.com/github/super-linter/tree/master/TEMPLATES) 

    folder



#### Enable or disable linters



!!! info "Note about `VALIDATE_[LANGUAGE]` variables from super-linter [README](https://github.com/github/super-linter#environment-variables){:target="_blank"}"

jobs/super_linter/super_linter.yml

+1 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ super_linter: 
    RUN_LOCAL: "true"

    DEFAULT_WORKSPACE: $CI_PROJECT_DIR

    DEFAULT_BRANCH: $CI_DEFAULT_BRANCH

    LINTER_RULES_PATH: ".linters"

    OUTPUT_FORMAT: "tap"

    OUTPUT_DETAILS: "detailed"

    OUTPUT_FOLDER: "super-linter.report"

jobs/super_linter/versions/0.2.1.md

0 → 100644
+2 −0
Original line number Diff line number Diff line 
* Improve documentation for `$LINTER_RULES_PATH`

* Default value for `$LINTER_RULES_PATH` is now `.linters`

jobs/trivy_image/README.md

+6 −4
Original line number Diff line number Diff line
@@ -7,10 +7,10 @@ vulnerability detection capabilities are available in its official 
[README](https://github.com/aquasecurity/trivy#vulnerability-detection){:target="_blank"}



!!! warning

    With the default configuration, this job will fail if errors are detected.

    With the default configuration, this job will fail if detected errors are in severity `MEDIUM`,`HIGH`,`CRITICAL`.

    It's the recommended configuration to reduce security risks in your

    software. You can disable this behaviour by setting the value `0` to the

    variable `TRIVY_EXIT_CODE`.

    software. You can disable this behaviour by emptying the value of the

    variable `TRIVY_EXIT_ON_SEVERITY`.



## How to use it
@@ -36,7 +36,8 @@ vulnerability detection capabilities are available in its official 
|:-|:-|:-

| `TRIVY_VERSION` <img width=450/> | Version of trivy to use. Releases version are available [here](https://github.com/aquasecurity/trivy/releases){:target="_blank"} | `0.9.2` |

| `TRIVY_SEVERITY` | Severities of vulnerabilities to be displayed | `UNKNOWN`,`LOW`,`MEDIUM`,`HIGH`,`CRITICAL`|

| `TRIVY_EXIT_CODE` | Exit code when vulnerabilities were found | 1 |

| `TRIVY_EXIT_ON_SEVERITY` | Severities of vulnerabilities for the job to fail at | `MEDIUM`,`HIGH`,`CRITICAL`|

| `TRIVY_EXIT_CODE` | Exit code when vulnerabilities were found | 0 |

| `TRIVY_VULN_TYPE` | List of vulnerability types | os,library |

| `TRIVY_OUTPUT` | Output file name | junit-report.xml |

| `TRIVY_IGNOREFILE` | Specify .trivyignore file | .trivyignore |
@@ -46,6 +47,7 @@ vulnerability detection capabilities are available in its official 
| `TRIVY_CLEAR_CACHE` | Clear image caches without scanning | false |

| `TRIVY_IGNORE_UNFIXED` | Display only fixed vulnerabilities | false |

| `TRIVY_DEBUG` | Debug mode | false |

| `TRIVY_OPTIONS` | Options for command `trivy` | ` ` |

| `DOCKER_HOST` | Daemon socket to connect to | tcp://docker:2375 |

| `TRIVY_TIMEOUT` | Docker timeout | 2m0s |

| `TRIVY_LIGHT` | Trivy faster without descriptions and refs | false |