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.

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

[Docs] Add the K8s agent set up document #6184

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

shuyingliang
Copy link

@shuyingliang shuyingliang commented Jan 22, 2025

Tracking issue

Related to flyteorg/flytekit#3004

Why are the changes needed?

Adding the documentation for the flyte K8s service agent

What changes were proposed in this pull request?

docs

How was this patch tested?

local sandbox

Labels

Please add one or more of the following labels to categorize your PR:

  • added: For new features.

This is important to improve the readability of release notes.

Setup process

In the doc

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

flyteorg/flytekit#3004

Summary by Bito

Added comprehensive documentation for Kubernetes Data Service Agent setup in Flyte deployments, including cluster configuration, RBAC setup, and upgrade procedures. Documentation focuses on implementing non-training tasks for data operations, particularly beneficial for deep learning applications. Key improvements include terminology standardization, renaming 'K8s Service Agent' to 'K8s Data Service Agent', and enhanced descriptions of StatefulSet and Service operations.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 1

@flyte-bot
Copy link
Collaborator

flyte-bot commented Jan 22, 2025

Code Review Agent Run #ddf77f

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 80a8790..da6aaea
    • docs/deployment/agents/k8sservice.rst
  • Files skipped - 1
    • docs/deployment/agents/index.md - Reason: Filter setting
  • Tools
    • Golangci-lint (Linter) - ✖︎ Failed
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

AI Code Review powered by Bito Logo

@flyte-bot
Copy link
Collaborator

flyte-bot commented Jan 22, 2025

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Documentation - K8s Service Agent Setup Documentation

k8sservice.rst - Added comprehensive guide for setting up and configuring Kubernetes Service Agent in Flyte

@shuyingliang shuyingliang changed the title Add the K8s agent set up document [Docs] Add the K8s agent set up document Jan 22, 2025
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.06%. Comparing base (29ad645) to head (06a804f).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6184      +/-   ##
==========================================
- Coverage   37.06%   37.06%   -0.01%     
==========================================
  Files        1318     1318              
  Lines      132644   132644              
==========================================
- Hits        49167    49166       -1     
- Misses      79228    79229       +1     
  Partials     4249     4249              
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.33% <ø> (ø)
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.87% <ø> (ø)
unittests-flytepropeller 42.70% <ø> (ø)
unittests-flytestdlib 55.27% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@flyte-bot
Copy link
Collaborator

flyte-bot commented Jan 22, 2025

Code Review Agent Run #175b17

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: f691658..f691658
    • docs/deployment/agents/k8sservice.rst
  • Files skipped - 1
    • docs/deployment/agents/index.md - Reason: Filter setting
  • Tools
    • Golangci-lint (Linter) - ✖︎ Failed
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

AI Code Review powered by Bito Logo

Copy link
Contributor

@davidmirror-ops davidmirror-ops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions.
Thank you for contributing!

docs/deployment/agents/k8sservice.rst Outdated Show resolved Hide resolved
docs/deployment/agents/k8sservice.rst Outdated Show resolved Hide resolved
docs/deployment/agents/k8sservice.rst Outdated Show resolved Hide resolved
docs/deployment/agents/k8sservice.rst Outdated Show resolved Hide resolved
docs/deployment/agents/k8sservice.rst Outdated Show resolved Hide resolved
@flyte-bot
Copy link
Collaborator

flyte-bot commented Jan 23, 2025

Code Review Agent Run #baf2c9

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: f691658..06a804f
    • docs/deployment/agents/k8sservice.rst
  • Files skipped - 0
  • Tools
    • Golangci-lint (Linter) - ✖︎ Failed
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

AI Code Review powered by Bito Logo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants