Documented API for Kubernetes on Swagger UI
- APIS AND ACCESS -- APIs and Access -- Swagger and OpenAPI
I could not find documented API for Kubernetes on Swagger UI. Please provide full link to enter, because only part of URL path is visible.
Answers
-
Hi @oleksazhel,
Refrences to the Swagger tool and the OpenAPI can be found in the official Kubernetes documentation and Kubernetes github repository.
Regards,
-Chris-1 -
@chrispokorni said:
Hi @oleksazhel,Refrences to the Swagger tool and the OpenAPI can be found in the official Kubernetes documentation and Kubernetes github repository.
Regards,
-ChrisI don't need reference to Swagger tool it exists inside training course. I need URL to enter inside Swagger tool which is called Swagger UI or Cloud version which is called SwaggerHub.
0 -
From the Swagger homepage you can easily access SwaggerHub, UI, Editor, Codegen, and others Pro tools.
You may be asked to create an account first.
Otherwise to access your cluster's API, there are a few articles and blog posts outside of Kubernetes and Swagger documentation, that guide you on how to access it locally and visualize various resource APIs.Regards,
-Chris0 -
@chrispokorni said:
From the Swagger homepage you can easily access SwaggerHub, UI, Editor, Codegen, and others Pro tools.
You may be asked to create an account first.
Otherwise to access your cluster's API, there are a few articles and blog posts outside of Kubernetes and Swagger documentation, that guide you on how to access it locally and visualize various resource APIs.Regards,
-ChrisI know that I can access SwaggerHub of course, and of course I created account... Quote from training material: "you can browse some of the API groups via a Swagger UI on the https://swagger.io/specification/". So my assumption is that it means that there is some documented Kates API which I can access via SwaggerHub and I need just name of that public API to find it and check. The question is not about how to deploy swagger locally and bind to existing Kates cluster. Do you see?
0 -
@oleksazhel I think I've found out the answer to your question, I'm roughly in the same course part and I did some googling.
So the documentation is avaliable via the kubernetes API and then you need to host a swagger instance on your own:
commands: # open the proxy to the API # kubectl proxy --port=8080 # download JSON with the documentation curl localhost:8080/openapi/v2 > k8s-openapi-v2.json # run the swagger ui instance docker run \ -v $PWD/k8s-openapi-v2.json:/app/swagger.json \ -p 8081:8080 \ swaggerapi/swagger-ui
I was able to access the swagger-ui using URL http://10.0.1.10:8081/ (in my case 10.0.1.10 is my virtual machine ip)
0 -
@kzwolenik Thank you for your detailed answer, but question wasn't about how to run Swagger UI in docker and use previously fetched data from local Kuber CP with proxying request to it. I also saw this info in Goolge) If you look into https://trainingportal.linuxfoundation.org/learn/course/kubernetes-fundamentals-lfs258/apis-and-access/apis-and-access?page=14 you will find a part of external URL in the screenshot. Thus I suppose that there is some link you can enter to your Swagger UI and you don't need any local Kuber CP to get data from. Although I realize that they may provide this URL just as an example and may be it is closed for the world.
0 -
I think you are right.
0 -
Go to Swagger UI demo page: https://petstore.swagger.io/
Use browser extension to allow cross origin requests.
Go to Kubernetes github page. Pick whatever release branch / commit you want and navigate to open ai spec.
Example of master branch: https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json
Example of specific release branch: https://github.com/kubernetes/kubernetes/blob/release-1.25/api/openapi-spec/swagger.json
Right click "View raw" and copy link address.
Paste link in Swagger UI demo page.0
Categories
- 10.2K All Categories
- 36 LFX Mentorship
- 89 LFX Mentorship: Linux Kernel
- 505 Linux Foundation Boot Camps
- 279 Cloud Engineer Boot Camp
- 104 Advanced Cloud Engineer Boot Camp
- 48 DevOps Engineer Boot Camp
- 41 Cloud Native Developer Boot Camp
- 2 Express Training Courses
- 2 Express Courses - Discussion Forum
- 1.8K Training Courses
- 17 LFC110 Class Forum
- 5 LFC131 Class Forum
- 20 LFD102 Class Forum
- 148 LFD103 Class Forum
- 13 LFD121 Class Forum
- 61 LFD201 Class Forum
- LFD210 Class Forum
- 1 LFD213 Class Forum - Discontinued
- 128 LFD232 Class Forum
- 23 LFD254 Class Forum
- 570 LFD259 Class Forum
- 100 LFD272 Class Forum
- 1 LFD272-JP クラス フォーラム
- 1 LFS145 Class Forum
- 23 LFS200 Class Forum
- 739 LFS201 Class Forum
- 1 LFS201-JP クラス フォーラム
- 1 LFS203 Class Forum
- 46 LFS207 Class Forum
- 298 LFS211 Class Forum
- 53 LFS216 Class Forum
- 46 LFS241 Class Forum
- 41 LFS242 Class Forum
- 37 LFS243 Class Forum
- 10 LFS244 Class Forum
- 27 LFS250 Class Forum
- 1 LFS250-JP クラス フォーラム
- 131 LFS253 Class Forum
- 998 LFS258 Class Forum
- 10 LFS258-JP クラス フォーラム
- 87 LFS260 Class Forum
- 126 LFS261 Class Forum
- 31 LFS262 Class Forum
- 79 LFS263 Class Forum
- 15 LFS264 Class Forum
- 10 LFS266 Class Forum
- 17 LFS267 Class Forum
- 17 LFS268 Class Forum
- 21 LFS269 Class Forum
- 201 LFS272 Class Forum
- 1 LFS272-JP クラス フォーラム
- 212 LFW211 Class Forum
- 154 LFW212 Class Forum
- 899 Hardware
- 217 Drivers
- 74 I/O Devices
- 44 Monitors
- 115 Multimedia
- 208 Networking
- 101 Printers & Scanners
- 85 Storage
- 749 Linux Distributions
- 88 Debian
- 64 Fedora
- 14 Linux Mint
- 13 Mageia
- 24 openSUSE
- 133 Red Hat Enterprise
- 33 Slackware
- 13 SUSE Enterprise
- 355 Ubuntu
- 473 Linux System Administration
- 38 Cloud Computing
- 69 Command Line/Scripting
- Github systems admin projects
- 94 Linux Security
- 77 Network Management
- 108 System Management
- 49 Web Management
- 63 Mobile Computing
- 22 Android
- 27 Development
- 1.2K New to Linux
- 1.1K Getting Started with Linux
- 528 Off Topic
- 127 Introductions
- 213 Small Talk
- 20 Study Material
- 796 Programming and Development
- 264 Kernel Development
- 498 Software Development
- 923 Software
- 258 Applications
- 182 Command Line
- 2 Compiling/Installing
- 76 Games
- 316 Installation
- 54 All In Program
- 54 All In Forum
Upcoming Training
-
August 20, 2018
Kubernetes Administration (LFS458)
-
August 20, 2018
Linux System Administration (LFS301)
-
August 27, 2018
Open Source Virtualization (LFS462)
-
August 27, 2018
Linux Kernel Debugging and Security (LFD440)