{"id":21408551,"url":"https://github.com/chengyumeng/khadijah","last_synced_at":"2025-07-14T00:34:25.331Z","repository":{"id":64302679,"uuid":"141075219","full_name":"chengyumeng/khadijah","owner":"chengyumeng","description":"A command-line tool that makes Qihoo360/Wayne easier to use with kubernetes. ","archived":false,"fork":false,"pushed_at":"2019-02-20T07:41:40.000Z","size":12211,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-22T09:34:23.500Z","etag":null,"topics":["golang","kubernetes","wayne"],"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/chengyumeng.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-16T02:10:51.000Z","updated_at":"2023-03-28T07:08:58.000Z","dependencies_parsed_at":"2023-01-15T09:45:32.800Z","dependency_job_id":null,"html_url":"https://github.com/chengyumeng/khadijah","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chengyumeng%2Fkhadijah","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chengyumeng%2Fkhadijah/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chengyumeng%2Fkhadijah/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chengyumeng%2Fkhadijah/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chengyumeng","download_url":"https://codeload.github.com/chengyumeng/khadijah/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225934413,"owners_count":17547740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["golang","kubernetes","wayne"],"created_at":"2024-11-22T17:17:04.126Z","updated_at":"2024-11-22T17:17:04.792Z","avatar_url":"https://github.com/chengyumeng.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Khadijah\n\n[![Build Statue](https://travis-ci.org//chengyumeng/khadijah.svg?branch=master)](https://travis-ci.org/chengyumeng/khadijah)\n[![Build Release](https://img.shields.io/github/release/chengyumeng/Khadijah.svg)](https://github.com/chengyumeng/khadijah/releases)\n[![Go Report Card](https://goreportcard.com/badge/github.com/chengyumeng/khadijah)](https://goreportcard.com/report/github.com/chengyumeng/khadijah)\n\nKhadijah 是一款基于奇虎 360 开源的 Wayne 的 kubernetes 命令行管理工具。\n\n### 为什么使用 Khadijah ?\n\n\n## Feature\n\n- 支持了多种 Wayne OpenAPI 的接口调用\n- 支持了跨部门、跨项目的资源信息查询\n- 支持了 Kubernetes 原生信息的查询\n- 支持了基于 Wayne 的权限管理下的从命令行进入 Kubernetes Pod 容器的远程 Shell\n\n## 快速安装\n\n```bash\ngo get -u github.com/chengyumeng/khadijah\n```\n\n```bash\nkhadijah config set --apikey=example --websocketurl=ws://127.0.0.1:8080 --baseurl=http://127.0.0.1:4200\n# 必须指定 baseurl，该值为 Wayne 服务的 http(s)地址\n# websocketurl 是用于远程 Shell 的 Wayne 地址，可以按需指定\n# apikey 为需要调用 Wayne OpenAPI 需要指定的值（khadijah query 下所有操作依赖于这个值）\n```\n\n```bash\nkhadijah login -uadmin -padmin\n```\n\n```bash\nkhadijah get namespace\nName: admin Email:admin@360.cn\n\n+----+--------------+-----------------+-------------------------------+-------------------------------+\n| ID |     NAME     |      USER       |          CREATETIME           |          UPDATETIME           |\n+----+--------------+-----------------+-------------------------------+-------------------------------+\n| 27 | argo         | admin           | 2018-12-26 11:01:08 +0800 CST | 2018-12-26 11:01:08 +0800 CST |\n+----+--------------+-----------------+-------------------------------+-------------------------------+\n```\n\n```bash\nkhadijah get deployment -n=infra\n+-----+----------------------------------------+------------+-----+-----------+-------------+-------------------------------+\n| ID  |                  NAME                  |    TYPE    | APP | NAMESPACE |    USER     |          CREATETIME           |\n+-----+----------------------------------------+------------+-----+-----------+-------------+-------------------------------+\n|   1 | infra-wayne                            | deployment |     |           | admin       | 2018-05-30 16:59:59 +0800 CST |\n|   2 | infra-test                             | deployment |     |           | admin       | 2018-05-30 17:20:22 +0800 CST |\n|   3 | infra-cpu                              | deployment |     |           | admin       | 2018-05-31 10:36:21 +0800 CST |\n+-----+----------------------------------------+------------+-----+-----------+-------------+-------------------------------+\n```\n\n```bash\nkhadijah describe deployment move-num1 -n=infra -o=pretty\n+-----------+-----------+---------+--------------------------------+------------------------------+----------+--------------------------------+---------------------------+\n|   NAME    | NAMESPACE | CLUSTER |             LABELS             |            CONTAINERS        | REPLICAS |            MESSAGE             |           PODS            |\n+-----------+-----------+---------+--------------------------------+------------------------------+----------+--------------------------------+---------------------------+\n| move-num1 | infra     | K8S-1   | app:move-num1 qihoo-app:move   | php:docker.hub/php:1.1.0     | 1/1      | 2018-12-10 19:03:00 +0800      | move-num1-945d9577f-wnvtm |\n|           |           |         | qihoo-ns:infra                 | nginx:docker.hub/nginx:1.1.0 |          | CST:Deployment has minimum     |                           |\n|           |           |         |                                | qconf:docker.hub/agent:0.1.0 |          | availability. 2018-12-11       |                           |\n|           |           |         |                                |                              |          | 14:52:19 +0800 CST:ReplicaSet  |                           |\n|           |           |         |                                |                              |          | \"move-num1-945d9577f\" has      |                           |\n|           |           |         |                                |                              |          | successfully progressed.       |                           |\n+-----------+-----------+---------+--------------------------------+------------------------------+----------+--------------------------------+---------------------------+\n```\n\n```bash\nkhadijah query getpodinfo -c=K8S-1 --label=app\n```\n```json\n{\n  \"code\": 200,\n  \"pods\": [\n    {\n      \"podIp\": \"172.17.4.44\",\n      \"labels\": {\n        \"app\": \"move-num1\",\n        \"pod-template-hash\": \"501851339\",\n        \"qihoo-app\": \"move\",\n        \"qihoo-ns\": \"infra\"\n      }\n    }\n  ]\n}\n```\n\n## 原理\n\nkhadijah 的工作基于 Wayne 的两个特性：\n\n- OpenAPI\n- Web API\n\n用户可以配置独立调用两种 API，在使用之前，务必配置 Wayne 服务地址,例如：\n```bash\nkhadijah config set --baseurl=http://www.wayne.cloud\n```\n\n调用 OpenAPI 接口，需配置 APIKey:\n```bash\nkhadijah config set --apikey=xxx\n```\n\nOpenAPI 接口的调用方式举例：\n```bash\nkhadijah query getvipinfo -p=18080 \n```\n\n调用 websocket （需要安装插件）:\n```bash\nkhadijah config set --websocketurl=ws://www.wayne.cloud\n```\n\n如需调用 Web API 接口，需要在 Wayne 上通过管理员设置登录密码， Wayne 设置路径为：\n\n管理后台 =》权限 =》 用户列表 =》 重置密码\n\n之后可以通过如下命令登录：\n```bash\nkhadijah login -uadmin -padmin\n```\n\n恭喜你，之后就可以调用一切接口！\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchengyumeng%2Fkhadijah","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchengyumeng%2Fkhadijah","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchengyumeng%2Fkhadijah/lists"}