Skip to content

✨ feat: add new shortcut #11

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

Merged
outscale-ykr merged 6 commits into from
Aug 27, 2025
Merged

✨ feat: add new shortcut #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7734338
:sparkles: feat: add new shortcut
outscale-rde Aug 13, 2025
3a88973
Merge branch 'main' into feat/Add_new_shortcut
outscale-rde Aug 25, 2025
e49c380
fix conflict
outscale-rde Aug 26, 2025
0dd703c
:sparkles: feat: remove unnecessary shortcuts and remove shortcuts wi…
outscale-rde Aug 26, 2025
0be9271
:sparkles: feat: remove unnecessary shortcuts and remove shortcuts wi…
outscale-rde Aug 26, 2025
536a5a5
✨ feat: remove unnecessary shortcuts and remove shortcuts with two le…
outscale-rde Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions oks_cli/cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# DEFINE THE CACHE COMMAND GROUP
@click.group(help="Cache related commands.")
@click.option('--project-name', '-p', required = False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '-c', required = False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--cluster-name', '--name', '-c', required = False, help="Cluster Name", shell_complete=cluster_completer)
@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
def cache(ctx, project_name, cluster_name, profile):
Expand All @@ -21,7 +21,7 @@ def delete_cache(force):

@cache.command('kubeconfigs', help="List cached kubeconfigs")
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--plain', is_flag=True, help="Plain table format")
@click.option('--msword', is_flag=True, help="Microsoft Word table format")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
Expand Down
90 changes: 41 additions & 49 deletions oks_cli/cluster.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@

# DEFINE THE CLUSTER GROUP
@click.group(help="Cluster related commands.")
@click.option('--project', 'project_name', required = False, help="Project Name")
@click.option('--project-name', '-p', required = False, help="Project Name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required = False, help="Cluster Name")
@click.option('--cluster-name', '-c', required = False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
def cluster(ctx, project_name, cluster_name, profile):
Expand All @@ -31,7 +29,7 @@ def cluster(ctx, project_name, cluster_name, profile):

# LOGIN ON CLUSTER
@cluster.command('login', help="Set a default cluster")
@click.option('--cluster-name', '-c', required=False, help="Name of cluster", shell_complete=cluster_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Name of cluster", shell_complete=cluster_completer)
@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
def cluster_login(ctx, cluster_name, profile):
Expand Down Expand Up @@ -71,13 +69,12 @@ def cluster_logout(ctx, profile):
# LIST CLUSTERS
@cluster.command('list', help="List all clusters")
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required = False, help="Cluster Name")
@click.option('--cluster-name', '-c', required = False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--deleted', is_flag=True, help="List deleted clusters")
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--deleted', '-x', is_flag=True, help="List deleted clusters") # x pour "deleted" / "removed"
@click.option('--plain', is_flag=True, help="Plain table format")
@click.option('--msword', is_flag=True, help="Microsoft Word table format")
@click.option('--watch', '-w', is_flag=True, help="Watch the changes")
@click.option('-o', '--output', type=click.Choice(["json", "yaml", "wide"]), help="Specify output format")
@click.option('--output', '-o', type=click.Choice(["json", "yaml", "wide"]), help="Specify output format")
@click.option('--profile', help="Configuration profile to use")
@click.pass_context
def cluster_list(ctx, project_name, cluster_name, deleted, plain, msword, watch, output, profile):
Expand Down Expand Up @@ -215,10 +212,9 @@ def format_row(cluster):

# GET CLUSTER BY NAME
@cluster.command('get', help="Get a cluster by name")
@click.option('--project-name', '-p', required = False, help="Project Name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--cluster-name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--output', '-o', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
def cluster_get_command(ctx, project_name, cluster_name, output, profile):
Expand Down Expand Up @@ -313,22 +309,22 @@ def _create_cluster(project_name, cluster_config, output):
@cluster.command('create', help="Create a new cluster")
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--description', help="Description of the cluster")
@click.option('--admin', help="Admin Whitelist")
@click.option('--version', shell_complete=shell_completions, help="Kubernetes version")
@click.option('--description', '-d', help="Description of the cluster")
@click.option('--admin', '-a', help="Admin Whitelist")
@click.option('--version', '-v', shell_complete=shell_completions, help="Kubernetes version")
@click.option('--cidr-pods', help="CIDR of pods")
@click.option('--cidr-service', help='CIDR of services')
@click.option('--control-plane', shell_complete=shell_completions, help="Controlplane plan")
@click.option('--zone', multiple=True, shell_complete=shell_completions, help="List of Control Plane availability zones")
@click.option('--zone', '-z', multiple=True, shell_complete=shell_completions, help="List of Control Plane availability zones")
@click.option('--enable-admission-plugins', help="List of admission plugins, separated by commas")
@click.option('--disable-admission-plugins', help="List of admission plugins, separated by commas")
@click.option('--quirk', multiple=True, help="Quirk")
@click.option('--tags', help="Comma-separated list of tags, example: 'key1=value1,key2=value2'")
@click.option('--quirk', '-q', multiple=True, help="Quirk")
@click.option('--tags', '-t', help="Comma-separated list of tags, example: 'key1=value1,key2=value2'")
@click.option('--disable-api-termination', type=click.BOOL, help="Disable delete action by API")
@click.option('--cp-multi-az', is_flag=True, help="enable control plane multi az")
@click.option('--cp-multi-az', '-m', is_flag=True, help="Enable control plane multi AZ")
@click.option('--dry-run', is_flag=True, help="Client dry-run, only print the object that would be sent, without sending it")
@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('-f', '--filename', type=click.File("r"), help="Path to file to use to create the cluster ")
@click.option('--output', '-o', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--filename', '-f', type=click.File("r"), help="Path to file to use to create the cluster ")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
def cluster_create_command(ctx, project_name, cluster_name, description, admin, version, cidr_pods, cidr_service, control_plane, zone, enable_admission_plugins, disable_admission_plugins, quirk, tags, disable_api_termination, cp_multi_az, dry_run, output, filename, profile):
Expand Down Expand Up @@ -412,20 +408,19 @@ def cluster_create_command(ctx, project_name, cluster_name, description, admin,
# UPDATE CLUSTER
@cluster.command('update', help="Update a cluster by name")
@click.option('--project-name', '-p', required=False, help="Project name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required=False, help="Cluster name")
@click.option('--cluster-name', '-c', required=False, help="Cluster name", shell_complete=cluster_completer)
@click.option('--description', help="Description of the cluster")
@click.option('--admin', help="Admin Whitelist")
@click.option('--version', shell_complete=shell_completions, help="Kubernetes version")
@click.option('--tags', help="Comma-separated list of tags, example: 'key1=value1,key2=value2'")
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster name", shell_complete=cluster_completer)
@click.option('--description', '-d', help="Description of the cluster")
@click.option('--admin', '-a', help="Admin Whitelist")
@click.option('--version', '-v', shell_complete=shell_completions, help="Kubernetes version")
@click.option('--tags', '-t', help="Comma-separated list of tags, example: 'key1=value1,key2=value2'")
@click.option('--enable-admission-plugins', help="List of admission plugins, separated by commas")
@click.option('--disable-admission-plugins', help="List of admission plugins, separated by commas")
@click.option('--quirk', multiple=True, help="Quirk")
@click.option('--quirk', '-q', multiple=True, help="Quirk")
@click.option('--disable-api-termination', type=click.BOOL, help="Disable delete action by API")
@click.option('--control-plane', shell_complete=shell_completions, help="Controlplane plan")
@click.option('--dry-run', is_flag=True, help="Client dry-run, only print the object that would be sent, without sending it")
@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('-f', '--filename', type=click.File("r"), help="Path to file to use to update the cluster ")
@click.option('--output', '-o', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--filename', '-f', type=click.File("r"), help="Path to file to use to update the cluster ")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
def cluster_update_command(ctx, project_name, cluster_name, description, admin, version, tags, enable_admission_plugins, disable_admission_plugins, quirk, disable_api_termination, control_plane, dry_run, output, filename, profile):
Expand Down Expand Up @@ -500,9 +495,8 @@ def cluster_update_command(ctx, project_name, cluster_name, description, admin,
# UPGRADE CLUSTER
@cluster.command('upgrade', help="Upgrade a cluster by name")
@click.option('--project-name', '-p', required=False, help="Project name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required=False, help="Cluster name")
@click.option('--cluster-name', '-c', required=False, help="Cluster name", shell_complete=cluster_completer)
@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster name", shell_complete=cluster_completer)
@click.option('--output', '-o', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--force', is_flag=True, help="Force upgrade")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
@click.pass_context
Expand All @@ -522,9 +516,8 @@ def cluster_update_command(ctx, project_name, cluster_name, output, force, profi
# DELETE CLUSTER BY NAME
@cluster.command('delete', help="Delete a cluster by name")
@click.option('--project-name', '-p', required=False, help="Project name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required=False, help="Cluster name")
@click.option('--cluster-name', '-c', required=False, help="Cluster name", shell_complete=cluster_completer)
@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster name", shell_complete=cluster_completer)
@click.option('--output', '-o', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--dry-run', is_flag=True, help="Run without any action")
@click.option('--force', is_flag=True, help="Force deletion without confirmation")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
Expand Down Expand Up @@ -554,8 +547,7 @@ def cluster_delete_command(ctx, project_name, cluster_name, output, dry_run, for
# GET KUBECONFIG
@cluster.command('kubeconfig', help="Fetch the kubeconfig for a cluster")
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--name', 'cluster_name', required=False, help="Cluster name")
@click.option('--cluster-name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--print-path', is_flag=True, help="Print path to saved kubeconfig")
@click.option('--refresh', '--force', is_flag=True, help="Force refresh saved kubeconfig")
@click.option('--nacl', is_flag=True, help="Use public key encryption on wire (require api support)")
Expand Down Expand Up @@ -664,11 +656,11 @@ def _run_kubectl(project_id, cluster_id, user, group, args, input=None):

@cluster.command('kubectl', help='Fetch the kubeconfig for a cluster and run kubectl against it', context_settings={"ignore_unknown_options": True})
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--user', type=click.STRING, help="User")
@click.option('--group', type=click.STRING, help="Group")
@click.argument("args", nargs=-1, type=click.UNPROCESSED)
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
@click.argument("args", nargs=-1, type=click.UNPROCESSED)
@click.pass_context
def cluster_kubectl_command(ctx, project_name, cluster_name, user, group, args, profile):
"""CLI command to run kubectl against a specified cluster using its kubeconfig."""
Expand All @@ -681,9 +673,9 @@ def cluster_kubectl_command(ctx, project_name, cluster_name, user, group, args,
_run_kubectl(project_id, cluster_id, user, group, args)


@click.group(help="nodepool related commands.")
@click.group(help="Nodepool related commands.")
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--user', type=click.STRING, help="User")
@click.option('--group', type=click.STRING, help="Group")
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
Expand Down Expand Up @@ -711,14 +703,14 @@ def nodepool_list(ctx):
'get', 'nodepool', '-o', 'wide'])


@nodepool.command('create')
@nodepool.command('create', help="Create a new nodepool")
@click.option('--nodepool-name', '-n', default="nodepool01", help="Nodepool Name")
@click.option('--count', default=2, help="Count of nodes")
@click.option('--type', 'vmtype', default="tinav6.c2r4p3", help="Type of VMs")
@click.option('--zone', multiple=True, required=True, help="Provide zone")
@click.option('-o', '--output', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--count', '-c', default=2, help="Count of nodes")
@click.option('--type', 'vmtype', '-t', default="tinav6.c2r4p3", help="Type of VMs")
@click.option('--zone', '-z', multiple=True, required=True, help="Provide zone(s)")
@click.option('--output', '-o', type=click.Choice(["json", "yaml"]), help="Specify output format, by default is json")
@click.option('--dry-run', is_flag=True, help="Run without any action")
@click.option('-f', '--filename', type=click.File("r"), help="Path to file to use to create the Nodepool ")
@click.option('--filename', '-f', type=click.File("r"), help="Path to file to use to create the Nodepool")
@click.pass_context
def setup_worker_pool(ctx, nodepool_name, count, vmtype, zone, output, dry_run, filename):
"""Create a new nodepool in the cluster, optionally from a file or parameters."""
Expand Down
10 changes: 5 additions & 5 deletions oks_cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
from .cache import cache
from .quotas import quotas

from .utils import ctx_update, login_profile, install_completions, profile_completer, cluster_completer, project_completer
from .utils import ctx_update, install_completions, profile_completer, cluster_completer, project_completer

# Main CLI entry point
@click.group(invoke_without_command=True)
@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
@click.option('--project-name', '-p', required = False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '-c', required = False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('-v', '--verbose', count=True)
@click.option('--profile', help="Configuration profile to use", shell_complete=profile_completer)
@click.option('--project-name', '-p', required=False, help="Project Name", shell_complete=project_completer)
@click.option('--cluster-name', '--name', '-c', required=False, help="Cluster Name", shell_complete=cluster_completer)
@click.option('--verbose', '-v', count=True, help="Increase verbosity")
@click.pass_context
def cli(ctx, project_name, cluster_name, profile, verbose):
"""
Expand Down
Loading