ExternalVendorCode/onefuzz
1
0
Fork 0
mirror of https://github.com/microsoft/onefuzz.git synced 2025-06-23 14:57:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deprecating the job template feature (#2798)

Browse Source 
* deprecating the job template feature

* removing the code

* format
This commit is contained in:
Cheick Keita
2023-02-08 11:21:03 -08:00
committed by GitHub
parent d732028201
commit f13f52ab71
3 changed files with 9 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/declarative-templates.md → docs/deprecated/declarative-templates.md
View File

@ -1,4 +1,4 @@
# Declarative Job Templates
# Declarative Job Templates -- Deprecated
Provide the ability to maintain job templates, akin to `onefuzz template
libfuzzer basic` at the service level. The templates include a job
@ -94,7 +94,7 @@ TaskConfig(
## Hardcoded vs Runtime-specified Container Names
To support differentiating _always use "afl-linux" for tools_ vs _ask
To support differentiating _always use "afl-linux" for tools_ vs _ask
what container to use for setup_, if the container name is blank in the
template, it will be provided as part of the `JobTemplateConfig` and in the
resulting `JobTemplateRequest`.

14
docs/managing-templates.md → docs/deprecated/managing-templates.md
View File

@ -1,4 +1,4 @@
# Managing Declarative Job Templates
# Managing Declarative Job Templates -- Deprecated
[Declarative Job Templates](declarative-templates.md), currently a preview
feature, allow a user to define a reusable fuzzing pipeline as a template.
@ -6,7 +6,7 @@ Once saved, any user of the OneFuzz instance can create fuzzing jobs based on
the templates.
This is a walk-through guide for updating an existing job template, though
the process is similar for creating templates from scratch.
the process is similar for creating templates from scratch.
This process demonstrates adding [Microsoft Teams
notifications](notifications/teams.md) for new unique crash reports to an existing
@ -27,9 +27,9 @@ notifications](notifications/teams.md) for new unique crash reports to an existi
onefuzz job_templates manage get libfuzzer_linux > libfuzzer_linux.json
```
3. With your preferred text editor, add the following to the `notifications` list:
```json
```json
{
"container_type": "unique_reports",
"container_type": "unique_reports",
"notification": {
"config": {
"url": "https://contoso.com/webhook-url-here"
@ -120,7 +120,7 @@ Now let's make use of our new template.
"job_id": "d3259dfe-fdad-45a0-bf90-a381b8dc1ee8",
"state": "init"
}
$
$
```
3. Verify a notification was set up for the unique reports container
```
@ -160,7 +160,7 @@ This example will demonstrate setting the following:
onefuzz job_templates manage get libfuzzer_linux > libfuzzer_linux_ado_areapath.json
```
3. With your preferred text editor, add the following to the `notifications` list:
```json
```json
{
"container_type": "unique_reports",
"notification": {
@ -234,7 +234,7 @@ This example will demonstrate setting the following:
onefuzz job_templates refresh
```
Using `--help`, we can see the new optional and required arguments.
Using `--help`, we can see the new optional and required arguments.
```
$ onefuzz job_templates submit libfuzzer_linux_ado_areapath --help
usage: onefuzz job_templates submit libfuzzer_linux_ado_areapath [-h] [-v] [--format {json,raw}] [--query QUERY]