You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+39-2Lines changed: 39 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,33 @@
1
+
# v11.0.0
2
+
3
+
Kubernetes API Version: 1.15.10
4
+
5
+
**API Change:**
6
+
7
+
- Deleting CustomObjects doesn't require passing in the body anymore [kubernetes-client/gen#142](https://github.com/kubernetes-client/gen/pull/142)
8
+
9
+
**New Feature:**
10
+
11
+
- Add ability to the client to be used as Context Manager [kubernetes-client/python#1073](https://github.com/kubernetes-client/python/pull/1073)
12
+
- Enable the use of dynamic client [kubernetes-client/python#1035](https://github.com/kubernetes-client/python/pull/1035)
13
+
- Add option to refresh gcp token when config is cmd-path [kubernetes-client/python-base#175](https://github.com/kubernetes-client/python-base/pull/175)
14
+
15
+
**Bug Fix:**
16
+
17
+
- Add kubernetes.dynamic to setup.py pkg list[kubernetes-client/python#1096](https://github.com/kubernetes-client/python/pull/1096)
18
+
- Fix custom object API example[kubernetes-client/python#1049](https://github.com/kubernetes-client/python/pull/1049)
19
+
- Fix deprecation warning in E2E tests [kubernetes-client/python#1036](https://github.com/kubernetes-client/python/pull/1036)
20
+
- Use `==/!=` to compare str, bytes, and int literals [kubernetes-client/python#1007](https://github.com/kubernetes-client/python/pull/1007)
- Fix persist_config flag and function calls [kubernetes-client/python-base#169](https://github.com/kubernetes-client/python-base/pull/169)
23
+
- Fix memory inneficiencies in the WebSocket client [kubernetes-client/python-base#178](https://github.com/kubernetes-client/python-base/pull/178)
24
+
- Fix functionality to watch logs when log line is not a JSON-serialized object [kubernetes-client/python-base#171](https://github.com/kubernetes-client/python-base/pull/171)
25
+
- Detect binary payloads and send the correct opcode [kubernetes-client/python-base#152](https://github.com/kubernetes-client/python-base/pull/152)
26
+
27
+
**Deprecation Notice**
28
+
v11.0.0 of the client follows the Kubernetes [deprecation policy](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md#supported-releases-and-component-skew) and will
29
+
be deprecated as and when Kubernetes version v1.15 gets deprecated.
30
+
1
31
# v11.0.0b2
2
32
**Bug Fix:**
3
33
- Fix a fatal bug in package setup [kubernetes-client/python#1011](https://github.com/kubernetes-client/python/pull/1011)
@@ -44,6 +74,13 @@
44
74
- Update `_load_azure_token` to handle str and int [kubernetes-client/python-base#141](https://github.com/kubernetes-client/python-base/pull/141)
45
75
- Correct regex to properly parse rfc3339 microseconds [kubernetes-client/python-base#150](https://github.com/kubernetes-client/python-base/pull/150)
46
76
77
+
# v10.0.1
78
+
**Bug Fix:**
79
+
- Fix content type regression in custom object patch API [kubernetes-client/python#866](https://github.com/kubernetes-client/python/issues/866)
80
+
81
+
**Security Fix:**
82
+
- Bump urllib3 version to pick up security fix for CVE-2019-11324 [kubernetes-client/python#897](https://github.com/kubernetes-client/python/pull/897)
83
+
47
84
# v10.0.0
48
85
**Bug Fix:**
49
86
- Fix base64 padding for kube config [kubernetes-client/python-base#79](https://github.com/kubernetes-client/python-base/pull/79)
@@ -270,7 +307,7 @@
270
307
- Restricting the websocket-client to <=0.40 #299
271
308
272
309
# v3.0.0a1
273
-
- Update client to kubernetes 1.7
310
+
- Update client to kubernetes 1.7
274
311
- Support ThirdPartyResources (TPR) and CustomResourceDefinitions (CRD). Note that TPR is deprecated in kubernetes #251#201
275
312
- Better dependency management #136
276
313
- Add support for python3.6 #244
@@ -325,7 +362,7 @@
325
362
326
363
# v1.0.0a3
327
364
328
-
- Add context switch to kube config loader #46
365
+
- Add context switch to kube config loader #46
329
366
- Add default kube config location #64
330
367
- Add suport for accessing multiple clusters #7
331
368
- Bugfix: Python client does not resolve relative paths in kubeconfig #68
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+68-5Lines changed: 68 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -13,14 +13,77 @@ Please fill out either the individual or corporate Contributor License Agreement
13
13
14
14
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
15
15
16
+
## Composition of This Repository and Where/How to Contribute
17
+
18
+
The Kubernetes Python client consists of this main repository (repo) and the base repo, the [python-base](https://github.com/kubernetes-client/python-base) repository. The main repository contains mostly files that are generated by the OpenAPI generator from [this OpenAPI spec](scripts/swagger.json). The base repo is the utility part of the python client and allows developers to create their own kubernetes clients. The base repo is a submodule of the main repo.
19
+
20
+
### Where to Submit Your Patch
21
+
22
+
The following folders are automatically generated. You will need to submit a patch to the upstream Kubernetes repo [kubernetes](https://github.com/kubernetes/kubernetes) or the OpenAPI generator repo [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
23
+
-[kubernetes/client](kubernetes/client)
24
+
-[kubernetes/test](kubernetes/test)
25
+
-[kubernetes/docs](kubernetes/docs).
26
+
27
+
In this main repo, the following folders contain developer written codes and the patches should be submitted as pull requests here:
28
+
-[kubernetes/e2e_test](kubernetes/e2e_test)
29
+
-[kubernetes/utils](kubernetes/utils)
30
+
-[examples](examples)
31
+
-[scripts](scripts).
32
+
33
+
The following folders and symbolic links in this main repo are in fact from the base repo. The base repo contains developer written codes only. The patches should be sent to the base repo instead:
34
+
- kubernetes/base
35
+
- kubernetes/config
36
+
- kubernetes/stream
37
+
- kubernetes/watch.
38
+
16
39
### Contributing A Patch
17
40
18
41
1. Submit an issue describing your proposed change to the repo in question.
19
-
1. The [repo owners](OWNERS) will respond to your issue promptly.
20
-
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
21
-
1. Fork the desired repo, develop and test your code changes.
22
-
1. Submit a pull request.
42
+
2. The [repo owners](OWNERS) will respond to your issue promptly.
43
+
3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
44
+
4. Fork the desired repo, develop and test your code changes. Add a test if possible.
45
+
5. Submit a pull request.
23
46
24
47
### Adding Dependencies
25
48
26
-
If your patch depends on new packages, add those packages to [requirements.txt](requirements.txt) and [setup.py](setup.py).
49
+
If your patch depends on new packages, add those packages to [requirements.txt](requirements.txt) and/or [setup.py](setup.py). If these package are for testing only, add those to [test-requirements.txt](test-requirements.txt).
50
+
51
+
### Commits
52
+
53
+
Generally we would like to see one commit per pull request. However, if the pull request is reasonably large, the PR can be divided into several commits that make logical sense. The commit message should be clear and indicative of the aim of the fix. Sometimes multiple commits in a single pull request is acceptable if it meets the Kubernetes [pull request guidelines](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#6-squashing-and-commit-titles).
54
+
55
+
If you have several commits in a pull request and have been asked to squash your commits, please use ```git reset --soft HEAD~N_COMMITS``` and commit again to make your PR a single commit.
56
+
57
+
### Windows Developers
58
+
59
+
The symbolic links contained in this repo do not work for Windows operating systems. If you are a Windows developer, please run the [fix](scripts/windows-setup-fix.bat) inside the scripts folder or manually copy the content of the [kubernetes/base](https://github.com/kubernetes-client/python-base) folder into the [kubernetes](kubernetes) folder.
60
+
61
+
### Writing Tests
62
+
63
+
In addition to running the fix yourself and telling us that your fix works, you can demonstrate that your fix really works by using unit tests and end to end tests. Tests are mainly located in three places. You should put your tests into the places that they fit in.
64
+
65
+
1.[Generated tests](kubernetes/test) by OpenAPI generator: these tests should pass and do not require modification.
66
+
2.[End to end tests](kubernetes/e2e_test): these are tests that can only be verified with a live kubernetes server.
67
+
3. Base repo tests in the [base](https://github.com/kubernetes-client/python-base) repo, in which the test files are named ```test_*.py```: These tests use the package ```Mock``` and confirms the functionality of the base repo files.
68
+
69
+
### Coding Style
70
+
71
+
We use an automatic coding style checker by using the ```diff``` of the autopep8 output and your code file. To make sure that your code passes the coding style checker, run ```autopep8 --in-place --aggressive --aggressive your_code.py``` before committing and submitting.
72
+
73
+
## Running Tests Locally
74
+
75
+
If you write a new end to end (e2e) test, or change behaviors that affect e2e tests, you should set up a local cluster and test them on your machine. The following steps will help you run the unit tests.
76
+
77
+
1. Acquire a local cluster. [Minikube](https://github.com/kubernetes/minikube) is a good choice for Windows and Linux developers. Alternatively if you are on Linux, you can clone the [kubernetes](https://github.com/kubernetes/kubernetes) repo and run [install-etcd.sh](https://github.com/kubernetes/kubernetes/blob/master/hack/install-etcd.sh) and then [local-up-cluster.sh](https://github.com/kubernetes/kubernetes/blob/master/hack/local-up-cluster.sh) to get a local cluster up and running.
78
+
79
+
2. Run the unit tests. In the root directory of the main repo, run ```python -m unittest discover```.
80
+
81
+
3. Check the test results and make corresponding fixes.
82
+
83
+
## Update the Base Submodule in the Main Repo After Your python-base PR Is Merged
84
+
85
+
Your contribution to the base repo will not be automatically reflected in the main repo after your PR is merged. Instead, please update the ```base``` submodule in your fork of the main repo as follows:
86
+
```bash
87
+
$ git submodule update --remote
88
+
```
89
+
You may now add a release note to [CHANGELOG.md](CHANGELOG.md) if needed and then commit and push to your fork. You can now send a PR to this main repo to complete your contribution.
0 commit comments