{"id":21657294,"url":"https://github.com/zcubbs/kwx","last_synced_at":"2026-04-28T23:37:36.653Z","repository":{"id":197663771,"uuid":"699092279","full_name":"zcubbs/kwx","owner":"zcubbs","description":"kWx is a Command-Line Interface (CLI) tool designed to simplify the deployment of AWX on Kubernetes. With just a few commands, you can install the AWX operator, set up an AWX instance, or uninstall them both.","archived":false,"fork":false,"pushed_at":"2023-11-09T03:33:21.000Z","size":363,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-16T09:19:14.925Z","etag":null,"topics":["awx","k8s"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zcubbs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-10-01T22:15:28.000Z","updated_at":"2024-02-29T07:39:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"8ed414f0-6d27-4738-a763-ee87e6dab332","html_url":"https://github.com/zcubbs/kwx","commit_stats":null,"previous_names":["zcubbs/kwx"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/zcubbs/kwx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fkwx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fkwx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fkwx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fkwx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zcubbs","download_url":"https://codeload.github.com/zcubbs/kwx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fkwx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32404340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T19:38:08.556Z","status":"ssl_error","status_checked_at":"2026-04-28T19:37:55.688Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["awx","k8s"],"created_at":"2024-11-25T09:20:37.873Z","updated_at":"2026-04-28T23:37:36.624Z","avatar_url":"https://github.com/zcubbs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kWx CLI\n\n`kWx` is a Command-Line Interface (CLI) tool designed to simplify the deployment of AWX on Kubernetes. With just a few commands, you can install the AWX operator, set up an AWX instance, or uninstall them both.\n\n---\n\u003cp align=\"center\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"350\" src=\"docs/assets/logo.png\"\u003e\n\u003c/p\u003e\n\n---\n\n## Features\n\n- **Install AWX-Operator:** Quickly deploy the AWX-Operator on your Kubernetes cluster.\n- **Deploy AWX Instance:** Set up an AWX instance using default or customized configurations.\n- **Clean Uninstallation:** Easily uninstall both the operator and instance when needed.\n\n## Installation\n```bash\ncurl -sfL https://raw.githubusercontent.com/zcubbs/kwx/main/scripts/install.sh | bash\n```\n\n## Configuration\n\nKWx optionally accepts a configuration file to customize your AWX deployment. The configuration is in YAML format. By default, the CLI uses the following settings:\n\n```yaml\nnamespace: awx\noperator:\n    helm_repo_url: https://ansible.github.io/awx-operator/\n    helm_repo_name: awx-operator\n    helm_chart_name: awx-operator\n    helm_release_name: awx-operator\ninstance:\n    name: awx\n    admin_user: admin\n    admin_pass: admin\n    is_node_port: false\n    node_port: 30080\n    no_log: true\n```\n\n### Config Struct\n\nHere's a brief overview of the configuration structure:\n\n- **Namespace:** Kubernetes namespace where the deployment will occur.\n- **Operator:** Settings for the AWX-Operator.\n    - **HelmRepoURL:** URL of the Helm repository.\n    - **HelmRepoName:** Name of the Helm repository.\n    - **HelmChartName:** Name of the Helm chart.\n    - **HelmRelease:** Helm release name.\n- **Instance:** Configuration for the AWX instance.\n    - **Name:** Instance name.\n    - **AdminUser \u0026 AdminPass:** AWX admin credentials.\n    - **IsNodePort:** Whether to use a NodePort service. If `true`, makes AWX accessible on a static port of the node.\n    - **NodePort:** The static port to expose AWX if `IsNodePort` is `true`.\n    - **NoLog:** If `true`, logging will be disabled.\n\n## Usage\n\n1. **Install AWX**:\n    ```bash\n    kwx awx install -c /path/to/config.yaml\n    ```\n\n2. **Uninstall AWX**:\n\n    ```bash\n    kwx awx uninstall -c /path/to/config.yaml\n    ```\nFor more detailed options and commands, use the `--help` flag.\n\n## Contributing\n\nContributions are welcome! If you find any issues, have suggestions, or would like to contribute code, please open an issue or a pull request on our GitHub page.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcubbs%2Fkwx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzcubbs%2Fkwx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcubbs%2Fkwx/lists"}