Skip to content

Adds docs for named profiles#213

Open
JyotinderSingh wants to merge 3 commits intomainfrom
profiles-docs
Open

Adds docs for named profiles#213
JyotinderSingh wants to merge 3 commits intomainfrom
profiles-docs

Conversation

@JyotinderSingh
Copy link
Copy Markdown
Collaborator

Depends on PR #212

Adds documentation for named profiles for the kinetic CLI.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces named profiles to the Kinetic CLI, enabling users to bundle project, zone, cluster, and namespace configurations under a single name. This feature simplifies switching between infrastructure targets by integrating profiles into the configuration precedence hierarchy (CLI flag > Env var > Profile > Default). The implementation includes a new kinetic profile command group for lifecycle management, atomic JSON storage, and updates to the config show command for improved visibility. I have no feedback to provide.

Copy link
Copy Markdown
Member

@jeffcarp jeffcarp left a comment

Choose a reason for hiding this comment

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

lgtm with some nits

Comment thread docs/guides/profiles.md
# Profiles

A **profile** bundles the four settings that determine where a Kinetic
job runs — project, zone, cluster, and namespace — under a single name.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you link to the configuration page that explains what these all do?

Comment thread docs/guides/profiles.md
- You move between projects or namespaces often enough that exporting
env vars manually is slowing you down.
- Multiple people share a machine or dotfiles and need clean switching
between their own configurations.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe mention a benefit is being able to utilize spot capacity across regions?

Comment thread docs/guides/profiles.md
between their own configurations.

For single-cluster setups, plain `KINETIC_*` env vars are still the
simplest path.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe link here as well to the config page that shows how to use these env vars?

Comment thread docs/guides/profiles.md

## Storage

Profiles live in a single JSON file at `~/.kinetic/profiles.json`:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you mention (here or maybe above in the intro) that profiles are local and per-user and aren't synced across the team?

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.

2 participants