Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#25478 API Design (GitOps mode) #26269

Closed
wants to merge 9 commits into from
Closed

#25478 API Design (GitOps mode) #26269

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dbea332
Update rest-api.md
rachaelshaw Jan 17, 2025
6226d95
Update rest-api.md
rachaelshaw Jan 23, 2025
1c557bd
API design: Move GitOps settings into their own config object
rachaelshaw Jan 23, 2025
864fca9
Cleanup from previous GitOps mode API design
rachaelshaw Jan 23, 2025
c4c92c7
Update rest-api.md
rachaelshaw Jan 27, 2025
54b0fbb
Update docs/REST API/rest-api.md
rachaelshaw Jan 28, 2025
aec178b
Configuration API: Move `change_management` out of `integrations`
rachaelshaw Feb 11, 2025
c591417
`change_management` -> `gitops`
rachaelshaw Feb 13, 2025
8ad3c30
Update docs/REST API/rest-api.md
rachaelshaw Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/REST API/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,6 +946,10 @@ None.
"vulnerability_settings": {
"databases_path": ""
},
"gitops": {
"gitops_mode_enabled": false,
"repository_url": "",
},
"webhook_settings": {
"host_status_webhook": {
"enable_host_status_webhook": true,
Expand Down Expand Up @@ -1054,6 +1058,7 @@ Modifies the Fleet's configuration with the supplied information.
| agent_options | objects | body | The agent_options spec that is applied to all hosts. In Fleet 4.0.0 the `api/v1/fleet/spec/osquery_options` endpoints were removed. |
| fleet_desktop | object | body | See [fleet_desktop](#fleet-desktop). |
| webhook_settings | object | body | See [webhook_settings](#webhook-settings). |
| gitops | object | body | See [gitops](#gitops). |
| integrations | object | body | Includes `ndes_scep_proxy` object and `jira`, `zendesk`, and `google_calendar` arrays. See [integrations](#integrations) for details. |
| mdm | object | body | See [mdm](#mdm). |
| features | object | body | See [features](#features). |
Expand Down Expand Up @@ -1226,6 +1231,10 @@ Modifies the Fleet's configuration with the supplied information.
"fleet_desktop": {
"transparency_url": "https://fleetdm.com/better"
},
"gitops": {
"gitops_mode_enabled": false,
"repository_url": "",
},
"webhook_settings": {
"host_status_webhook": {
"enable_host_status_webhook": true,
Expand Down Expand Up @@ -1478,6 +1487,28 @@ _Available in Fleet Premium._
}
```

#### gitops

_Available in Fleet Premium._

| Name | Type | Description |
| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| gitops_mode_enabled | boolean | Whether to enable "GitOps mode", which restricts making changes via the UI that would be overridden by running `fleetctl-gitops`. (Default: `false`) |
| repository_url | string | The URL for the repository where changes are managed, for Fleet instances using GitOps. Users will be sent here when GitOps mode is enabled. |

<br/>

##### Example request body

```json
{
"gitops": {
"gitops_mode_enabled": true,
"repository_url": "https://github.com/exampleorg/it-and-security"
}
}
```

#### webhook_settings

<!--
Expand Down Expand Up @@ -1591,6 +1622,7 @@ _Available in Fleet Premium._
| google_calendar | array | See [`integrations.google_calendar`](#integrations-google-calendar). |
| ndes_scep_proxy | object | See [`integrations.ndes_scep_proxy`](#integrations-ndes-scep-proxy). |


<br/>

##### integrations.jira
Expand Down
Loading