From a7fb74a62d2ee9b8e68139d01c22cdfee2b38186 Mon Sep 17 00:00:00 2001 From: TannerGabriel Date: Wed, 6 Jul 2022 11:57:53 +0200 Subject: [PATCH] Update feature documentation Signed-off-by: TannerGabriel --- docs/FEATURES.md | 52 +++++++++++++++++++++++++++--------------------- 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/docs/FEATURES.md b/docs/FEATURES.md index 1e222a42..6db15263 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -1,28 +1,34 @@ ## Features -- [Features](#Features) - - [Getting started](#getting-started) - - [Specifying the working directory](#specifying-the-working-directory) - - [Event Matching](#event-matching) - - [Kubernetes Job](#kubernetes-job) - - [Kubernetes Job Environment Variables](#kubernetes-job-environment-variables) - - [From Events](#from-events) - - [From Kubernetes Secrets](#from-kubernetes-secrets) - - [From String Literal](#from-string-literal) - - [File Handling](#file-handling) - - [Silent mode](#silent-mode) - - [Resource quotas](#resource-quotas) - - [Poll duration](#poll-duration) - - [Job namespace](#job-namespace) - - [Job security context](#job-security-context) - - [Job image pull policy](#job-image-pull-policy) - - [Job service account](#job-service-account) - - [Restrict job images](#restrict-job-images) - - [Limit network access](#limit-network-access) - - [Additional Event Data](#additional-event-data) - - [Remote Control Plane](#remote-control-plane) - - [Job clean-up](#job-clean-up) +- [Features](#features) + - [Getting started](#getting-started) + - [Specifying the working directory](#specifying-the-working-directory) + - [Event Matching](#event-matching) + - [Kubernetes Job](#kubernetes-job) + - [Kubernetes Job Environment Variables](#kubernetes-job-environment-variables) + - [From Events](#from-events) + - [From Kubernetes Secrets](#from-kubernetes-secrets) + - [From String Literal](#from-string-literal) + - [File Handling](#file-handling) + - [Silent mode](#silent-mode) + - [Resource quotas](#resource-quotas) + - [Poll duration](#poll-duration) + - [Job namespace](#job-namespace) + - [Specify annotations for Job](#specify-annotations-for-job) + - [Job security context](#job-security-context) + - [Job Image Pull Policy](#job-image-pull-policy) + - [Job service account](#job-service-account) + - [Restrict job images](#restrict-job-images) + - [Limit network access](#limit-network-access) + - [Enabling the network-policies when installing/upgrading job-executor-service](#enabling-the-network-policies-when-installingupgrading-job-executor-service) + - [Ingress policy](#ingress-policy) + - [Egress policy](#egress-policy) + - [Network policy for jobs](#network-policy-for-jobs) + - [Send start/finished event if the job config.yaml can't be found](#send-startfinished-event-if-the-job-configyaml-cant-be-found) + - [Additional Event Data](#additional-event-data) + - [Remote Control Plane](#remote-control-plane) + - [Job clean-up](#job-clean-up) ### Getting started @@ -427,7 +433,7 @@ tasks: ### Specify annotations for Job -Custom annotations can be added to Job definitions which is needed for workloads/tools to inject secrets into jobs or execute other functionality on jobs. +Custom annotations can be added to Job definitions which can be used by third-party tools to inject secrets into jobs or execute other functionality on jobs. ```yaml tasks: