Skip to content

Commit

Permalink
chore: cleanup Makefile, update docs regarding default resyncPeriod (#…
Browse files Browse the repository at this point in the history
…1795)

* Doc: Update default resyncPeriod

* Chore: Align Makefile Ko version with #1700

* Chore: Remove duplicate chainsaw binary path search
  • Loading branch information
Baarsgaard authored Dec 16, 2024
1 parent 1c2641c commit ac4e3b0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
13 changes: 3 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,6 @@ else
GOBIN=$(shell go env GOBIN)
endif

CHAINSAW_VERSION ?= v0.2.10

# Checks if chainsaw is in your PATH
ifneq ($(shell which chainsaw),)
CHAINSAW=$(shell which chainsaw)
else
CHAINSAW=$(shell pwd)/bin/chainsaw
endif

# Setting SHELL to bash allows bash commands to be executed by recipes.
# Options are set to exit when a recipe line exits non-zero or a piped command fails.
SHELL = /usr/bin/env bash -o pipefail
Expand Down Expand Up @@ -161,7 +152,9 @@ KUSTOMIZE_VERSION ?= v5.1.1
CONTROLLER_TOOLS_VERSION ?= v0.16.3
OPM_VERSION ?= v1.23.2
YQ_VERSION ?= v4.35.2
KO_VERSION ?= v0.16.0
KIND_VERSION ?= v0.24.0
CHAINSAW_VERSION ?= v0.2.10

KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
.PHONY: kustomize
Expand Down Expand Up @@ -320,7 +313,7 @@ ko:
ifeq (, $(shell which ko))
@{ \
set -e ;\
go install github.com/google/ko@v0.13.0 ;\
go install github.com/google/ko@${KO_VERSION} ;\
}
KO=$(GOBIN)/ko
else
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Due to this the Grafana operator has to constantly poll the Grafana API to test
To control how often this polling should occur, you can set the `spec.resyncPeriod` field.
This field tells the operator how often it should poll the Grafana instance for changes.

So, if for example, a dashboard has changed, the operator comes in and overwrite those settings after `5m` by default.
So, if for example, a dashboard has changed, the operator comes in and overwrite those settings after `10m` by default.
If you never want the operator to poll for changes in the dashboards you need to set this value to `0m`:

```yaml
Expand Down

0 comments on commit ac4e3b0

Please sign in to comment.