kctl
Rancher Kubernetes API compatible with RKE, RKE2 and maybe others?
Documentation is WIP.
Quickstart
pip install --upgrade kctl
Usage
from lazycls.envs import set_env_from_dict
"""
---
Primary Configuration that takes env variables first.
---
host = envToStr('KCTL_HOST', 'http://localhost')
api_key = envToStr('KCTL_API_KEY')
api_key_prefix = envToStr('KCTL_API_KEY_PREFIX', 'token:')
api_token = envToStr('KCTL_API_TOKEN')
username = envToStr('KCTL_API_USERNAME')
password = envToStr('KCTL_API_PASSWORD')
auth_prefix = envToStr('KTCL_AUTH_PREFIX', 'authorization')
---
Rancher Specific Configuration
---
host: str = KctlCfg.host,
api_version: str = 'v1',
api_token: str = KctlCfg.api_token,
ssl_verify: bool = True,
strict: bool = False,
cache_time: int = 86400,
cache_dir: Union[Path, str] = DefaultCacheDir,
rancher_default_cluster: str = None,
rancher_fleet_name: str = 'fleet-default',
clusters_enabled: List[str] = [],
clusters_disabled: List[str] = []
---
Then validates against env variables during initialization, prioritizing env variables.
---
api_version = envToStr('KCTL_API_VERSION', api_version or 'v1')
ssl_verify = envToBool('KCTL_SSL_VERIFY', str(ssl_verify))
strict = envToBool('KCTL_STRICT', str(strict))
cache_time = envToInt('KCTL_CACHE_TIME', cache_time)
cache_dir = to_path(envToStr('KCTL_CACHE_DIR', None) or cache_dir)
rancher_default_cluster = envToStr('KCTL_RANCHER_DEFAULT_CLUSTER', rancher_default_cluster)
rancher_fleet_name = envToStr('KCTL_RANCHER_FLEET_NAME', rancher_fleet_name)
# If both are empty, then it will assume all clusters are enabled.
clusters_enabled = envToList('KCTL_CLUSTERS_ENABLED', clusters_enabled)
clusters_disabled = envToList('KCTL_CLUSTERS_DISABLED', clusters_disabled)
"""
data = {
'KCTL_HOST': 'https://ranchercluster.com',
'KCTL_API_TOKEN': 'token-xxxx:yyyyyyyyyyyyyyyyyyyyyyyyyyyy'
}
set_env_from_dict(data, override=True)
from kctl.client import KctlClient
## Rancher Specific
## This will build the object class dynamically
## enabling v1/v3 api methods.
## v3 is typically the management cluster
## v1 is cluster specific
KctlClient.build_rancher_ctx()
## KctlClient is a Class that doesnt require initialization
## Sync Method
cs = KctlClient.v3.list_cluster()
## Async Method
cs = await KctlClient.v3.async_list_cluster()
cs.data[-1].name
"""
local
"""
## Change Cluster Context
KctlClient.set_cluster('staging-cluster')
KctlClient.v1.url
"""
Now the primary api url will be called using the proper k8s path
-> https://ranchercluster.com/k8s/clusters/c-m-xxxxxx
"""
KctlClient.v1.list_apps_deployment()
"""
All v1 methods will now return the specified cluster context
{
'type': 'collection',
'links': {'self': 'https://ranchercluster.com/k8s/clusters/c-m-xxxxxx/v1/apps.deployments/fleet-default'},
'createTypes': {'apps.deployment': 'https://ranchercluster.com/k8s/clusters/c-m-xxxxxx/v1/apps.deployments'},
'actions': {},
'resourceType': 'apps.deployment',
'revision': '6671325',
'data': []
}
"""
Enhancements
This library borrows the dynamic initialization method from the primary rancher-client python library with several enhancements.
-
Async and Sync support via
httpx/lazyapi, which can be initialized from a sync environment. -
All async methods are accessed with
async_prefix of the same sync methods. -
Inclusion of kubernetes python client which can be called via
KctlClient.api, allowing setting of credentials once. Although this use case has not been extensively tested. (or rather, at all.) -
Dynamic Access of downstream clusters without requiring reinitialization of the client
-
Enables context switching between clusters
-
Lazy caching of the api schema in
kctl/kctl/.kctlcache -
Enables access of v1/v3 api methods within the same client.
-
All returned results are objects, allowing dynamic access of object attributes, rather than strictly
dictbased. -
Adds support for
fleetnamespaces to ensure proper url handling
Credits / Libraries Used
-
rancher-client: inspired dynamic schema initialization
-
kubernetes: included to manage credentials
-
lazyapi: personal library that is used to create the
httpxclients. -
lazycls: personal library that contains a lot of utility functions that enables this library to be as slim as possible.
49 Dec 14, 2022
202 Nov 19, 2022
205 Dec 30, 2022
35.1k Jan 2, 2023
8 Oct 25, 2022
8 Nov 26, 2022
2.4k Jan 4, 2023
1 Dec 1, 2022
2 Feb 11, 2022
1 Jan 13, 2022
1 Dec 20, 2021
9 Dec 18, 2022
6.6k Jan 08, 2023
7 Nov 23, 2022
29 Dec 14, 2022
1 Jan 28, 2022
128 Oct 18, 2022
1.1k Dec 30, 2022
11.8k Jan 07, 2023
7 Mar 31, 2022
648 Jan 02, 2023
8 Dec 20, 2021
10 Dec 02, 2022
6 Aug 28, 2022
94 Oct 10, 2022
1.1k Dec 31, 2022
1 Dec 30, 2021