oks-cli 1.14__tar.gz

oks_cli-1.14/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Outscale SAS
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

oks_cli-1.14/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: oks-cli
+Version: 1.14
+Author: Outscale SAS
+Author-email: opensource@outscale.com
+License: BSD
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: certifi>=2024.8.30
+Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: click>=8.1.7
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: idna>=3.10
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: requests>=2.32.3
+Requires-Dist: urllib3>=2.2.3
+Requires-Dist: human-readable
+Requires-Dist: prettytable
+Requires-Dist: python-dateutil
+Requires-Dist: altgraph>=0.17.4
+Requires-Dist: pynacl>=1.5.0
+Requires-Dist: pyOpenSSL>=25.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4.1; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+
+# OKS-CLI
+
+[![Project Incubating](https://docs.outscale.com/fr/userguide/_images/Project-Incubating-blue.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)
+[![](https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat&theme=default-inverted)](https://discord.gg/HUVtY5gT6s)
+
+<p align="center">
+  <img alt="Kubernetes" src="https://upload.wikimedia.org/wikipedia/commons/3/39/Kubernetes_logo_without_workmark.svg" width="120px">
+</p>
+
+---
+
+## 🌐 Links
+
+* 📘 [OKS-CLI Documentation](https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html)
+* 📘 [OKS API Reference](https://docs.outscale.com/oks.html)
+* 🐛 [GitHub Issues](https://github.com/outscale/oks-cli/issues)
+
+---
+
+## 📄 Table of Contents
+
+* [Overview](#-overview)
+* [Requirements](#-requirements)
+* [Installation](#-installation)
+
+  * [Standard Installation](#standard-installation)
+  * [User Installation](#user-installation)
+* [Usage](#-usage)
+
+  * [Commands](#commands)
+  * [Examples](#examples)
+* [Development](#-development)
+
+  * [Editable Mode](#editable-mode)
+  * [Project Structure](#project-structure)
+  * [Dependencies](#dependencies)
+* [Contributing](#-contributing)
+* [License](#-license)
+* [Support](#-support)
+
+---
+
+## 🧭 Overview
+
+**OKS-CLI** is a command-line interface that allows you to deploy and manage Kubernetes clusters on top of OUTSCALE infrastructure.
+
+---
+
+## ✅ Requirements
+
+* Python 3.11 or later
+* `pip` (Python package manager)
+* `kubectl` (required for commands that interact with the Kubernetes API)
+
+---
+
+## 📦 Installation
+
+### Standard Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/outscale/oks-cli.git
+cd oks-cli
+
+# Create and activate a virtual environment
+python -m venv venv
+source venv/bin/activate
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Install the CLI in editable mode
+pip install -e .
+```
+
+### User Installation
+
+Install globally without a virtual environment (Python 3.11):
+
+```bash
+pip3.11 install -e --user .
+```
+
+> **Note:** Ensure `~/Library/Python/3.11/bin` (macOS) or the equivalent path is in your `PATH`.
+
+---
+
+## 🚀 Usage
+
+Display all available commands:
+
+```bash
+oks-cli fullhelp
+```
+
+### Commands
+
+| Command                              | Description                                                   |
+|--------------------------------------|---------------------------------------------------------------|
+| profile list                         | List existing profiles                                        |
+| profile add                          | Add AK/SK or username/password new profile                    |
+| profile delete                       | Delete a profile by name                                      |
+| profile update                       | Update an existing profile                                    |
+| project list                         | List all projects                                             |
+| project create                       | Create a new project                                          |
+| project get                          | Get default project or the project by name                    |
+| project update                       | Update a project by name                                      |
+| project delete                       | Delete a project by name                                      |
+| project login                        | Set a default project by name                                 |
+| project logout                       | Unset default project                                         |
+| project quotas                       | Get project quotas                                            |
+| project snapshots                    | Get project snapshots                                         |
+| project publicips                    | Get project public ips                                        |
+| cluster list                         | List all clusters                                             |
+| cluster create                       | Create a new cluster                                          |
+| cluster get                          | Get a cluster by name                                         |
+| cluster update                       | Update a cluster by name                                      |
+| cluster upgrade                      | Upgrade a cluster by name                                     |
+| cluster delete                       | Delete a cluster by name                                      |
+| cluster login                        | Set a default cluster                                         |
+| cluster logout                       | Unset default cluster                                         |
+| cluster kubeconfig                   | Fetch the kubeconfig for a cluster                            |
+| cluster kubectl                      | Fetch kubeconfig and run kubectl against it                   |
+| cluster nodepool list                | List nodepools in the specified cluster                       |
+| cluster nodepool create              | Create a new nodepool in the cluster                          |
+| cluster nodepool delete              | Delete a nodepool by name from the cluster                    |
+| cache clear                          | Clear cache                                                   |
+| cache kubeconfigs                    | List cached kubeconfigs                                       |
+| quotas                               | Get quotas                                                    |
+| fullhelp                             | Display detailed help information for all commands            |
+| version                              | Show the current CLI version                                  |
+| install-completion                   | Install shell completion scripts                              |
+
+---
+
+### Examples
+
+```bash
+# List all projects
+oks-cli project list
+
+# Dry run project creation
+oks-cli project create --project-name my-project --description "Test project" --dry-run
+
+# Dry run cluster creation
+oks-cli cluster create \
+  --cluster-name my-cluster \
+  --project-name my-project \
+  --description "My test cluster" \
+  --version "1.32" \
+  --dry-run
+
+# Set a default project profile
+oks-cli project login --project-name my-project
+```
+
+---
+
+## 🛠 Development
+
+### Editable Mode
+
+Install the CLI in editable mode with development dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+Changes in the `oks_cli/` directory will be immediately reflected without reinstalling.
+
+### Tests
+
+Run the test suite using `pytest` to ensure code correctness and stability:
+
+```bash
+pytest
+```
+
+### Project Structure
+
+```
+oks-cli/
+├── oks_cli/              # Source code
+│   ├── cache.py
+│   ├── cluster.py
+│   ├── main.py
+│   ├── profile.py
+│   ├── project.py
+│   ├── quotas.py
+│   └── utils.py
+├── setup.py              # Packaging configuration
+├── requirements.txt      # Dependencies
+└── README.md             # Project documentation
+```
+
+### Dependencies
+
+Dependencies are managed via `setup.py` and `requirements.txt`.
+
+To reinstall or update:
+
+```bash
+pip install -e .
+```
+
+---
+
+## 🤝 Contributing
+
+OKS-CLI is open source software licensed under BSD-3-Clause.
+
+We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and instructions.
+
+---
+
+## 📜 License
+
+**BSD-3-Clause**
+© Outscale SAS
+
+---
+
+## 🆘 Support
+
+* [Official Documentation](https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html)
+* [GitHub Issues](https://github.com/outscale/oks-cli/issues)

oks_cli-1.14/README.md

@@ -0,0 +1,227 @@
+# OKS-CLI
+
+[![Project Incubating](https://docs.outscale.com/fr/userguide/_images/Project-Incubating-blue.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)
+[![](https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat&theme=default-inverted)](https://discord.gg/HUVtY5gT6s)
+
+<p align="center">
+  <img alt="Kubernetes" src="https://upload.wikimedia.org/wikipedia/commons/3/39/Kubernetes_logo_without_workmark.svg" width="120px">
+</p>
+
+---
+
+## 🌐 Links
+
+* 📘 [OKS-CLI Documentation](https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html)
+* 📘 [OKS API Reference](https://docs.outscale.com/oks.html)
+* 🐛 [GitHub Issues](https://github.com/outscale/oks-cli/issues)
+
+---
+
+## 📄 Table of Contents
+
+* [Overview](#-overview)
+* [Requirements](#-requirements)
+* [Installation](#-installation)
+
+  * [Standard Installation](#standard-installation)
+  * [User Installation](#user-installation)
+* [Usage](#-usage)
+
+  * [Commands](#commands)
+  * [Examples](#examples)
+* [Development](#-development)
+
+  * [Editable Mode](#editable-mode)
+  * [Project Structure](#project-structure)
+  * [Dependencies](#dependencies)
+* [Contributing](#-contributing)
+* [License](#-license)
+* [Support](#-support)
+
+---
+
+## 🧭 Overview
+
+**OKS-CLI** is a command-line interface that allows you to deploy and manage Kubernetes clusters on top of OUTSCALE infrastructure.
+
+---
+
+## ✅ Requirements
+
+* Python 3.11 or later
+* `pip` (Python package manager)
+* `kubectl` (required for commands that interact with the Kubernetes API)
+
+---
+
+## 📦 Installation
+
+### Standard Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/outscale/oks-cli.git
+cd oks-cli
+
+# Create and activate a virtual environment
+python -m venv venv
+source venv/bin/activate
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Install the CLI in editable mode
+pip install -e .
+```
+
+### User Installation
+
+Install globally without a virtual environment (Python 3.11):
+
+```bash
+pip3.11 install -e --user .
+```
+
+> **Note:** Ensure `~/Library/Python/3.11/bin` (macOS) or the equivalent path is in your `PATH`.
+
+---
+
+## 🚀 Usage
+
+Display all available commands:
+
+```bash
+oks-cli fullhelp
+```
+
+### Commands
+
+| Command                              | Description                                                   |
+|--------------------------------------|---------------------------------------------------------------|
+| profile list                         | List existing profiles                                        |
+| profile add                          | Add AK/SK or username/password new profile                    |
+| profile delete                       | Delete a profile by name                                      |
+| profile update                       | Update an existing profile                                    |
+| project list                         | List all projects                                             |
+| project create                       | Create a new project                                          |
+| project get                          | Get default project or the project by name                    |
+| project update                       | Update a project by name                                      |
+| project delete                       | Delete a project by name                                      |
+| project login                        | Set a default project by name                                 |
+| project logout                       | Unset default project                                         |
+| project quotas                       | Get project quotas                                            |
+| project snapshots                    | Get project snapshots                                         |
+| project publicips                    | Get project public ips                                        |
+| cluster list                         | List all clusters                                             |
+| cluster create                       | Create a new cluster                                          |
+| cluster get                          | Get a cluster by name                                         |
+| cluster update                       | Update a cluster by name                                      |
+| cluster upgrade                      | Upgrade a cluster by name                                     |
+| cluster delete                       | Delete a cluster by name                                      |
+| cluster login                        | Set a default cluster                                         |
+| cluster logout                       | Unset default cluster                                         |
+| cluster kubeconfig                   | Fetch the kubeconfig for a cluster                            |
+| cluster kubectl                      | Fetch kubeconfig and run kubectl against it                   |
+| cluster nodepool list                | List nodepools in the specified cluster                       |
+| cluster nodepool create              | Create a new nodepool in the cluster                          |
+| cluster nodepool delete              | Delete a nodepool by name from the cluster                    |
+| cache clear                          | Clear cache                                                   |
+| cache kubeconfigs                    | List cached kubeconfigs                                       |
+| quotas                               | Get quotas                                                    |
+| fullhelp                             | Display detailed help information for all commands            |
+| version                              | Show the current CLI version                                  |
+| install-completion                   | Install shell completion scripts                              |
+
+---
+
+### Examples
+
+```bash
+# List all projects
+oks-cli project list
+
+# Dry run project creation
+oks-cli project create --project-name my-project --description "Test project" --dry-run
+
+# Dry run cluster creation
+oks-cli cluster create \
+  --cluster-name my-cluster \
+  --project-name my-project \
+  --description "My test cluster" \
+  --version "1.32" \
+  --dry-run
+
+# Set a default project profile
+oks-cli project login --project-name my-project
+```
+
+---
+
+## 🛠 Development
+
+### Editable Mode
+
+Install the CLI in editable mode with development dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+Changes in the `oks_cli/` directory will be immediately reflected without reinstalling.
+
+### Tests
+
+Run the test suite using `pytest` to ensure code correctness and stability:
+
+```bash
+pytest
+```
+
+### Project Structure
+
+```
+oks-cli/
+├── oks_cli/              # Source code
+│   ├── cache.py
+│   ├── cluster.py
+│   ├── main.py
+│   ├── profile.py
+│   ├── project.py
+│   ├── quotas.py
+│   └── utils.py
+├── setup.py              # Packaging configuration
+├── requirements.txt      # Dependencies
+└── README.md             # Project documentation
+```
+
+### Dependencies
+
+Dependencies are managed via `setup.py` and `requirements.txt`.
+
+To reinstall or update:
+
+```bash
+pip install -e .
+```
+
+---
+
+## 🤝 Contributing
+
+OKS-CLI is open source software licensed under BSD-3-Clause.
+
+We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and instructions.
+
+---
+
+## 📜 License
+
+**BSD-3-Clause**
+© Outscale SAS
+
+---
+
+## 🆘 Support
+
+* [Official Documentation](https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html)
+* [GitHub Issues](https://github.com/outscale/oks-cli/issues)

oks_cli-1.14/oks_cli/cache.py

@@ -0,0 +1,63 @@
+import click
+from .utils import clear_cache, find_project_id_by_name, find_cluster_id_by_name, get_all_cache, get_expiration_date, ctx_update, login_profile, profile_completer
+import prettytable
+
+# DEFINE THE CACHE COMMAND GROUP
+@click.group(help="Cache related commands.")
+@click.option('--project-name', '-p', required = False, help="Project Name")
+@click.option('--cluster-name', '-c', required = False, help="Cluster Name")
+@click.option("--profile", help="Configuration profile to use", shell_complete=profile_completer)
+@click.pass_context
+def cache(ctx, project_name, cluster_name, profile):
+    """CLI command group for cache-related operations."""
+    ctx_update(ctx, project_name, cluster_name, profile)
+
+@cache.command('clear', help="Clear cache")
+@click.option('--force', is_flag=True, help="Force deletion without confirmation")
+def delete_cache(force):
+    """Clear all cached data, optionally without confirmation."""
+    if force or click.confirm("Are you sure you want to clear all cache?", abort=True):
+        clear_cache()
+
+@cache.command('kubeconfigs', help="List cached kubeconfigs")
+@click.option('--project-name', '-p', required=False, help="Project Name")
+@click.option('--cluster-name', '-c', required=False, help="Cluster Name")
+@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)
+@click.pass_context
+def list_kubeconfigs(ctx, project_name, cluster_name, plain, msword, profile):
+    """Display cached kubeconfigs with expiration dates in table format."""
+    project_name, cluster_name, profile = ctx_update(ctx, project_name, cluster_name, profile)
+    login_profile(profile)
+
+    project_id = find_project_id_by_name(project_name)
+    cluster_id = find_cluster_id_by_name(project_id, cluster_name)
+
+    result = get_all_cache(project_id, cluster_id, "kubeconfig")
+
+    table = prettytable.PrettyTable()
+    table.field_names = ["user",  "group", "expiration date"]
+
+    if plain:
+        table.set_style(prettytable.PLAIN_COLUMNS)
+
+    if msword:
+        table.set_style(prettytable.MSWORD_FRIENDLY)
+
+    for element in result:
+        kubeconfig = None
+        user = click.style(element['user'], bold=True)
+        group = click.style(element['group'], bold=True)
+
+        if element.get("cache_path"):
+            with open(element.get("cache_path")) as f:
+                kubeconfig = f.read()
+
+        if kubeconfig:
+            exp = get_expiration_date(kubeconfig)
+            row = user, group, exp
+
+            table.add_row(row)
+
+    click.echo(table)