Skip to content

Commit

Permalink
Update README.md (#59)
Browse files Browse the repository at this point in the history
+ Add "Why use GitOps?" link pointing to guide
+ Add "Fleet UI" section with description of GitOps mode
  • Loading branch information
rachaelshaw authored Jan 30, 2025
1 parent d7b26be commit d838c46
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This is the starter repository for using [Fleet](https://fleetdm.com) with a GitOps workflow.

[Why use GitOps?](https://fleetdm.com/guides/sysadmin-diaries-gitops-a-strategic-advantage#basic-article)

## GitHub setup

1. Clone the [GitHub repository](https://github.com/fleetdm/fleet-gitops), create your own GitHub repository, and push your clone to your new repo. Note that a workflow will run once and fail because the required variables haven't been added (step 2 and 3).
Expand Down Expand Up @@ -29,3 +31,14 @@ This is the starter repository for using [Fleet](https://fleetdm.com) with a Git
## Configuration options

For all configuration options, go to the [YAML files reference](https://fleetdm.com/docs/using-fleet/gitops) in the Fleet docs.

## Fleet UI

> _GitOps mode is coming soon. You can follow its progress [here](https://github.com/fleetdm/fleet/issues/25478)._
Once you're set up with GitOps in Fleet, you can optionally put the UI in GitOps mode. This prevents you from making changes in the UI that would be overridden by GitOps workflows.

An admin can enable GitOps mode in **Settings** > **Integrations** > **Change management**.

Note that this is a UI-only setting. API permissions are restricted based on user role.

0 comments on commit d838c46

Please sign in to comment.