Skip to main content

Openshift cluster login on command line

Project description

OCL (OpenShift Login)

PyPI PyPI platforms PyPI - License Release and Package Application

OCL does an automatic login to an OpenShift cluster. It fetches cluster information from app-interface and performs a login via Selenium.

Installation

You can install this library from PyPI with pip:

$ python3 -m pip install openshift-cluster-login

or install it with pipx:

$ pipx install openshift-cluster-login

You can also use pipx to run the library without installing it:

$ pipx run openshift-cluster-login

Usage

$ ocl

Features

OCL currently provides the following features (get help with -h or --help):

  • OpenShift console login (oc login) via GitHub authentication
  • Get cluster information from app-interface or user-defined (`OCL_USER_CLUSTERS``)
  • Open OpenShift console in browser (--open-in-browser)
  • Shell completion (--install-completion, --show-completion)
  • Credentials via environment variables or shell command (e.g. 1password CLI)

Environment Variables

Variable Name Description Required Default
OCL_GITHUB_USERNAME OCL_GITHUB_USERNAME_COMMAND Your GitHub username :heavy_check_mark:
OCL_GITHUB_PASSWORD OCL_GITHUB_PASSWORD_COMMAND Your GitHub password (e.g. command op read op://Private/Github/password) :heavy_check_mark:
OCL_GITHUB_TOTP OCL_GITHUB_TOTP_COMMAND Your GitHub two factor token (e.g. command op item get Github --otp) :heavy_check_mark:
OCL_WAIT OCL_WAIT_COMMAND Selenium webdriver wait timeout 2
OCL_APP_INTERFACE_URL OCL_APP_INTERFACE_URL_COMMAND App-Interface URL :heavy_check_mark:
OCL_APP_INT_TOKEN OCL_APP_INT_TOKEN_COMMAND App-Interface authentication token :heavy_check_mark:
USER_CLUSTERS USER_CLUSTERS_COMMAND User defined clusters as json format (e.g. [{"name": "local-kind", "serverUrl": "https://localhost:6443", "consoleUrl": "not available}]) "[]"

You can either set a variable, e.g. export OCL_GITHUB_USERNAME="mail@example.com" or retrieve it via a command, e.g. export OCL_GITHUB_USERNAME_COMMAND="op read op://Private/Github/username"

Limitations

  • MacOS only
  • Only Selenium webdriver.Chrome is supported and must be installed manually
    $ brew install --cask chromedriver
    

Development

Code style: black Checked with mypy

Use Conventional Commit messages. The most important prefixes you should have in mind are:

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
  • chore: release to create a new release

Consider using an empty commit:

git commit --allow-empty -m "chore: release"

When a commit to the main branch has Release-As: x.x.x (case insensitive) in the commit body, Release Please will open a new pull request for the specified version.

git commit --allow-empty -m "chore: release 2.0.0" -m "Release-As: 2.0.0"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openshift-cluster-login-0.1.5.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

openshift_cluster_login-0.1.5-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file openshift-cluster-login-0.1.5.tar.gz.

File metadata

  • Download URL: openshift-cluster-login-0.1.5.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.8.10 Linux/5.15.0-1017-azure

File hashes

Hashes for openshift-cluster-login-0.1.5.tar.gz
Algorithm Hash digest
SHA256 0d24a29511a7898633593070ba15149ef8141956401f70a2c90a5bf987950705
MD5 975eabcb453dd0d0e7375a2dc1b7253d
BLAKE2b-256 7766af6a86914ebfcafa681e3ecbbd559740bf2be74add7605ff72a2faaeca37

See more details on using hashes here.

File details

Details for the file openshift_cluster_login-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for openshift_cluster_login-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d92c49b83141f13b3d8a2be394408bdbf06fb3899f3fc5644c8d3561b0d47c40
MD5 a7f321ba7f20d9b473785705a0dffff2
BLAKE2b-256 be8d18fbe3d25a65c18f7ae5c06b9e2a8d3639866f32cd72b054f223182706cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page