docs: usage templates #753

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

Jump to bottom

Merged

lpuskas merged 74 commits into main from usage_templates

Oct 8, 2025

Contributor

sancyx commented Sep 28, 2025 •

edited by lpuskas

Loading

Description

The PR contains descriptions and practical guides to implement different deployment strategies for SLIM.
It also contains a series of minor fixes encountered during testing various strategies.

Contributor

github-actions bot commented Sep 28, 2025 •

edited

Loading

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`✅ passed`	Oct 8, 2025, 2:24 PM

codecov bot commented Sep 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

lpuskas requested a review from keraron

September 30, 2025 07:41

lpuskas force-pushed the usage_templates branch from 5194e1a to a5ffeff Compare

October 3, 2025 11:00

sancyx force-pushed the usage_templates branch from a8e309b to 67b4346 Compare

October 6, 2025 15:24

lpuskas force-pushed the usage_templates branch 2 times, most recently from 98ac688 to a13a8af Compare

October 7, 2025 08:36

sancyx changed the title ~~Usage templates~~ doc: usage templates

sancyx marked this pull request as ready for review

October 7, 2025 17:16

sancyx requested a review from a team as a code owner

October 7, 2025 17:16

sancyx changed the title ~~doc: usage templates~~ docs: usage templates

lpuskas and others added 19 commits

October 7, 2025 19:44


          feat: initial artifacts for deployment strategies

cdf7249

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: tasks for creating the kind cluster and deploying the naive str…

b95f3f5

…ategy

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: add other values files

ec51d0d

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          add config map

d48034c

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: move naive case into a dedicated folder

bf21f51

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: fixed, tested the naive strategy

c46fdf8

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: description for the naive strategy

68dd780

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: move the naive strategy related tasks into a dedicated taskfile

d15eb24

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: added placeholders for the statefulset and daemonset strategies

4fcbc07

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: placeholders / sections for the strategy descriptions

4d8c01b

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: fix task name pattern, moved strategy specific tasks to the de…

137af22

…dicated taskfile

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: infer slim image tag variable

d12ec3a

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: helm command syntax, paths corrected

3ccab17

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: fixed command syntax

cb818bf

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: set dev images

3ba325d

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          test deamonset

088fa7e

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix deamonset

68e474b

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: added dir to includes in taskfiles

b137de9

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: client apps cleanup, client app show logs

7b86612

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>

lpuskas and others added 18 commits

October 7, 2025 19:44


          chore: streamline client app tasks and description of naive startegy

9796a28

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: fixed tasks for the statefulset strategy

53e8440

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: fixed tasks for the daemonset strategy

8ad0223

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix statefulset/statefulset_strategy.md

2c82e25

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: add multi cluster description

cbaf7a3

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: include cli example tasks to multicluster strategy

c5f7499

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: deploy controller on separate cluster

fa1a56b

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: update description

165cf0f

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: fixes to statefulset description

57bd7b0

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: remove debug container from clients

ee4a555

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: test sender related task fixed for the multi cluster strategy

307ba66

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: add troubleshooting tips

a85e1f4

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: remove generated files

538d0a1

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: add generic command to handle k8s temlates; removed generated f…

bbe750b

…iles

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: corrected tasks to be executed for testing

c57e3f2

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: streamline tasks for the multi cluster strategy

b9d49eb

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          feat: use multinode cluster for daemonset strategy

2a53197

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>
Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: fix daemonset strategy

ec0e5d6

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>

sancyx force-pushed the usage_templates branch from 5ff9a48 to ec0e5d6 Compare

October 7, 2025 17:44

sancyx and others added 8 commits

October 7, 2025 21:18


          fix: statefulset strategy

3c93d04

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          fix: minor fixes to descriptions

c5a164f

Signed-off-by: Magyari Sandor Szilard <sancyx@gmail.com>


          chore: streamline the default task for strategies

a13399d

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>


          chore: streamline the naive strategy tasks

4b51096

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>


          chore: streamline the daemonset strategy tasks

0716ed7

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>


          chore: streamline the statefulset strategy tasks

5e23187

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>


          chore: streamline the multi-cluster strategy tasks

8b54bb1

Signed-off-by: Laszlo Puskas <laszlo.puskas1@gmail.com>


          chore: editorial review (#796)

54fd256

Review of the markdown files and text.

Signed-off-by: Aron Kerekes <arkereke@cisco.com>
Signed-off-by: László Puskás <laszlo.puskas1@gmail.com>
Co-authored-by: László Puskás <laszlo.puskas1@gmail.com>

lpuskas approved these changes

View reviewed changes

Contributor

lpuskas left a comment

lgtm

lpuskas merged commit 7bbb74f into main

6 checks passed

lpuskas deleted the usage_templates branch

October 8, 2025 15:04

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet