docs(README.md): Re-write README.md for the Swagger-based client #222
Conversation
silasbw
force-pushed
the
readme0
branch
2 times, most recently
from
734cd5b
to
ba23079
Compare
examples/basic.js
Outdated
| // | ||
| // Remove the Deployment we created. | ||
| // | ||
| const removed = await await client.apis.apps.v1.namespaces('default').deployments(deploymentManifest.metadata.name).delete(); |
There was a problem hiding this comment.
This looks like an accidental syntax error.
examples/basic.js
Outdated
| // | ||
| // Demonstrate some of the basics. | ||
| // | ||
| const Client = require('kubernetes-client').SyncClient |
| @@ -0,0 +1,41 @@ | |||
| // | |||
There was a problem hiding this comment.
I found this file confusing because of the usage of SyncClient - based on the naming, I expected to receive a client that had only synchronous methods, but on further investigation, the constructor is synchronous and the methods hanging off of it are async.
I'm not sure if this is confusing to others or just me.
There was a problem hiding this comment.
It's not you, it's me :) addressed in #225
silasbw
force-pushed
the
readme0
branch
2 times, most recently
from
4365812
to
97412c6
Compare
README-PRE-5.md
Outdated
| console.log(JSON.stringify(err || result, null, 2)); | ||
| } | ||
|
|
||
| core.namespaces('default').replicationcontrollers('http-rc').get(print); |
There was a problem hiding this comment.
This uses the default namespace, but the description of the example on line 32 says it is going to use the my-project namespace - is this intentional?
README-PRE-5.md
Outdated
| ### **Experimental** support for promises and async/await | ||
|
|
||
| kubernetes-client has **experimental** support for promises. If you | ||
| omit callbacks an HTTP method function (*e.g.*, `.get`), it will |
There was a problem hiding this comment.
nit: comma after "omit callbacks"
README-PRE-5.md
Outdated
| or with `async/await`: | ||
|
|
||
| ```js | ||
| print(null, await core.namespaces('default').replicationcontrollers('http-rc').get()); |
There was a problem hiding this comment.
This calls attention to print being a little weird - maybe just console.log the result?
README-PRE-5.md
Outdated
|
|
||
| ```js | ||
| const Api = require('kubernetes-client'); | ||
| const api = new Api.Api({ url: 'http://my-k8s-api-server.com' }); |
There was a problem hiding this comment.
Does this code get easier to read if line 115 turns into `const Api = require('kubernetes-client').Api;``?
| const thirdPartyResources = new Api.ThirdPartyResources({ | ||
| url: 'http://my-k8s-api-server.com', | ||
| group: 'kubernetes-client.io', | ||
| resources: ['customresources'] // Notice pluralization! |
There was a problem hiding this comment.
nit: customresources => customResources
There was a problem hiding this comment.
the lower case is correct for the (deprecated) third party resources.
README-PRE-5.md
Outdated
|
|
||
| // Access `customresources` as if they were a regular Kubernetes object | ||
| thirdPartyResources.ns('default').customresources.get(print); | ||
| thirdPartyResources.addResource('newresources'); // Notice pluralization! |
There was a problem hiding this comment.
nit: newresources => newResources
README-PRE-5.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| **Note:** the kube-apiserver will close watch connections eventually |
There was a problem hiding this comment.
I found this difficult to parse. Maybe something like this?
the kube-apiserver eventually closes
watchconnections
README-PRE-5.md
Outdated
| command line argument. kubernetes-client does not attempt to reconnect | ||
| when the kube-apiserver closes a connection. | ||
|
|
||
| ### Authenticating |
There was a problem hiding this comment.
Authenticating or Authentication?
silasbw
force-pushed
the
readme0
branch
2 times, most recently
from
748081c
to
ae715ed
Compare
BREAKING CHANGE: This commit effectively pivots the Swagger-based client to be the default, which isn't 100% compatible with the original kubernetes-client implementation.
No description provided.