From 36e7148247cd7b59d4a7ba6f63ef7ad29b883e71 Mon Sep 17 00:00:00 2001 From: Piotr Kazmierczak <470696+pkazmierczak@users.noreply.github.com> Date: Tue, 1 Jul 2025 16:28:33 +0200 Subject: [PATCH] scheduler: doc.go files for new packages (#26177) --- scheduler/doc.go | 6 ++++++ scheduler/feasible/doc.go | 6 ++++++ scheduler/reconciler/doc.go | 5 +++++ scheduler/structs/doc.go | 6 ++++++ 4 files changed, 23 insertions(+) create mode 100644 scheduler/doc.go create mode 100644 scheduler/feasible/doc.go create mode 100644 scheduler/reconciler/doc.go create mode 100644 scheduler/structs/doc.go diff --git a/scheduler/doc.go b/scheduler/doc.go new file mode 100644 index 000000000..b2db870c2 --- /dev/null +++ b/scheduler/doc.go @@ -0,0 +1,6 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: BUSL-1.1 + +// Package scheduler defines Nomad schedulers for service, batch, system, and +// sysbatch job types. +package scheduler diff --git a/scheduler/feasible/doc.go b/scheduler/feasible/doc.go new file mode 100644 index 000000000..6b058eff6 --- /dev/null +++ b/scheduler/feasible/doc.go @@ -0,0 +1,6 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: BUSL-1.1 + +// Package feasible contains the logic of picking the correct node(s) by the +// scheduler: eligibiligy, feasibility checking and ranking +package feasible diff --git a/scheduler/reconciler/doc.go b/scheduler/reconciler/doc.go new file mode 100644 index 000000000..c6db4095c --- /dev/null +++ b/scheduler/reconciler/doc.go @@ -0,0 +1,5 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: BUSL-1.1 + +// Package reconciler contains the reconciliation logic for all scheduler types. +package reconciler diff --git a/scheduler/structs/doc.go b/scheduler/structs/doc.go new file mode 100644 index 000000000..c65003a8f --- /dev/null +++ b/scheduler/structs/doc.go @@ -0,0 +1,6 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: BUSL-1.1 + +// Package structs contains definitions of shared objects, constants, and +// top-level interfaces for the scheduler. +package structs