Project

General

Profile

Actions

User story #21247

open

Add an API endpoint to export rules, directives, techniques, groups and their dependencies in an archive

Added by François ARMAND 19 days ago. Updated 6 days ago.

Status:
Pending technical review
Priority:
N/A
Category:
API
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:

Description

Add an API endpoint that would export rules and their dependencies: directives, techniques (with resources), groups.
Add the corresponding endpoint to import the same things (or a sub-set of that).

Part of the user story is to define the serialization format.
We want to use an archive, likely zip because of its wide availability, of files organized in directory by type that mimic content of /var/rudder/config-repo

We want to use a similar format too.
There is a question around revision since it does not have meaning out of the context of a Rudder, but may be important for understand things afterward. A middle ground could be to export it in archive, but ignore it in import (since we can't import things at a given revision, just on a branch).

Serialisation should be easely human updatable, even with long text. Yaml is a good candidate. A first version can use another format, as long as the feature is put behind a feature flag that needs to be enabled so that people are informed that the format is not definitive.

EDIT: this first user story will only be for exporting archive of items with (optionaly) their dependencies.
We use json for now, but would like to be able to change the format latter on, so we will put the feature behind a feature switch.
A second user story for the opposite action (import zip archive with json serialized objects) will be added as a subtask.


Subtasks 2 (2 open0 closed)

User story #21315: Add revision to node groupsPending releaseVincent MEMBRÉActions
User story #21321: Add API endpoint to import an archive of rules/etcIn progressFrançois ARMANDActions
Actions #1

Updated by François ARMAND 19 days ago

  • Status changed from New to In progress
  • Assignee set to François ARMAND
Actions #2

Updated by Alexis Mousset 15 days ago

  • Tracker changed from Bug to User story
  • Priority deleted (0)
Actions #10

Updated by François ARMAND 6 days ago

  • Subtask #21315 added
Actions #11

Updated by François ARMAND 6 days ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from François ARMAND to Vincent MEMBRÉ
  • Pull Request set to https://github.com/Normation/rudder/pull/4345
Actions #12

Updated by François ARMAND 6 days ago

  • Subject changed from Add API endpoint to export/import a rules, their directives, techniques, groups in an archive to Add API endpoint to export a rules, their directives, techniques, groups in an archive
  • Description updated (diff)
Actions #13

Updated by François ARMAND 6 days ago

  • Subject changed from Add API endpoint to export a rules, their directives, techniques, groups in an archive to Add Aan PI endpoint to export rules, directives, techniques, groups and their dependencies in an archive
Actions #14

Updated by François ARMAND 6 days ago

  • Subject changed from Add Aan PI endpoint to export rules, directives, techniques, groups and their dependencies in an archive to Add an API endpoint to export rules, directives, techniques, groups and their dependencies in an archive
Actions #15

Updated by François ARMAND 6 days ago

  • Subtask #21321 added
Actions

Also available in: Atom PDF