Skip to content

Release 10.0.0 #864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Jul 2, 2019
Merged

Release 10.0.0 #864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
06776ce
Rebase code and add namespaced method
johscheuer Mar 25, 2019
15d36c9
Use optional parameter for method
johscheuer Mar 26, 2019
80339ef
Add more documentation to new namespace parameter
johscheuer Apr 8, 2019
914b6aa
Updating Submodule for GCP Email Scope Addition
axelsteingrimsson Apr 9, 2019
7fb3a25
Merge pull request #809 from axelsteingrimsson/add_email_scope_to_gcp…
k8s-ci-robot Apr 9, 2019
a579f15
Fix broken dependencies.
Ark-kun Apr 23, 2019
89de1fa
Correct inconsistent spacing and typos
Apr 27, 2019
5e512ff
Merge pull request #820 from scottilee/docs
k8s-ci-robot Apr 27, 2019
05c1a43
Merge pull request #816 from Ark-kun/patch-1
k8s-ci-robot Jun 18, 2019
c86e489
Merge pull request #782 from johscheuer/create-from-yaml-namespaced
k8s-ci-robot Jun 18, 2019
d7300db
Don't use latest stable version for minikube
oz123 Jun 21, 2019
c4c18d9
Merge pull request #856 from oz123/test-suite-change-k8s-version
k8s-ci-robot Jun 25, 2019
14f97fc
update python-base submodule
roycaihw Jul 1, 2019
13394b0
add changelog for python-base update
roycaihw Jul 1, 2019
8622ac4
generated client update for 10.0.0-snapshot
roycaihw Jul 1, 2019
38e35af
add changelog for python repo changes; update readme
roycaihw Jul 1, 2019
c488354
Merge pull request #861 from roycaihw/release-10.0.0
k8s-ci-robot Jul 2, 2019
6cc3331
Merge branch 'master' of github.com:kubernetes-client/python into rel…
roycaihw Jul 2, 2019
47102be
update version constants for 10.0.0 release
roycaihw Jul 2, 2019
9c8bd4a
re-generated client for 10.0.0 release
roycaihw Jul 2, 2019
9e8b65c
add CHANGELOG for CR api change from kubernetes-client/gen repo
roycaihw Jul 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# v10.0.0
**Bug Fix:**
- Fix base64 padding for kube config [kubernetes-client/python-base#79](https://github.com/kubernetes-client/python-base/pull/79)
- Fix websocket client decoding binary message. Replace non-utf8 data instead of failing [kubernetes-client/python-base#104](https://github.com/kubernetes-client/python-base/pull/104)
- Add email scope to GCP provided credential refresh [kubernetes-client/python-base#110](https://github.com/kubernetes-client/python-base/pull/110)
- Fix broken urllib3 dependencies [kubernetes-client/python#816](https://github.com/kubernetes-client/python/pull/816)

**New Feature:**
- Add method to dynamically set namespace in yaml utility [kubernetes-client/python#782](https://github.com/kubernetes-client/python/pull/782)

**API Change:**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this happening on the release branch, not on master?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was merged yesterday kubernetes-client/gen#119 and gets included today since we pull the latest kubernetes-client/gen. It's a backwards-compatible fix IMO, so I keep it here. The master branch will sync up when we re-generate client there next time (11.0.0a1)

alternatively I can pin kubernetes-client/gen to exclude this change for this release. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. fine to include it.

- Add json-patch to custom object patch method [kubernetes-client/gen#119](https://github.com/kubernetes-client/gen/pull/119)

# v10.0.0a1
**Bug Fix:**
- Make watch work with read_namespaced_pod_log [kubernetes-client/python-base#93](https://github.com/kubernetes-client/python-base/pull/93)
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing guidelines
# Contributing Guidelines

## How to become a contributor and submit your own code

Expand All @@ -21,6 +21,6 @@ Follow either of the two links above to access the appropriate CLA and instructi
1. Fork the desired repo, develop and test your code changes.
1. Submit a pull request.

### Adding dependencies
### Adding Dependencies

If your patch depends on new packages, add those packages to [requirements.txt](requirements.txt) and [setup.py](setup.py).
1 change: 0 additions & 1 deletion OWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ approvers:
- lavalamp
- yliaog
- roycaihw

13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ python -m examples.example1

(replace example1 with the example base filename)


## Documentation

All APIs and Models' documentation can be found at the [Generated client's README file](kubernetes/README.md)
Expand Down Expand Up @@ -124,13 +123,13 @@ between client-python versions.
| 6.0 Alpha/Beta | Kubernetes main repo, 1.10 branch | ✗ |
| 6.0 | Kubernetes main repo, 1.10 branch | ✗ |
| 7.0 Alpha/Beta | Kubernetes main repo, 1.11 branch | ✗ |
| 7.0 | Kubernetes main repo, 1.11 branch | ✓ |
| 7.0 | Kubernetes main repo, 1.11 branch | ✗ |
| 8.0 Alpha/Beta | Kubernetes main repo, 1.12 branch | ✗ |
| 8.0 | Kubernetes main repo, 1.12 branch | ✓ |
| 9.0 Alpha/Beta | Kubernetes main repo, 1.13 branch | ✗ |
| 9.0 | Kubernetes main repo, 1.13 branch | ✓ |
| 10.0 Alpha/Beta | Kubernetes main repo, 1.14 branch | ✓ |

| 10.0 Alpha/Beta | Kubernetes main repo, 1.14 branch | ✗ |
| 10.0 | Kubernetes main repo, 1.14 branch | ✓ |

Key:

Expand All @@ -151,11 +150,10 @@ Participation in the Kubernetes community is governed by the [CNCF Code of Condu

## Kubernetes Incubator

This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/incubator.md).
This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/incubator.md).

* [SIG: sig-api-machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery)


## Troubleshooting

### SSLError on macOS
Expand All @@ -179,10 +177,11 @@ You'll need a version with OpenSSL version 1.0.0 or later.

### Hostname doesn't match

If you get an `ssl.CertificateError` complaining about hostname match, your installed packages does not meet version [requirements](requirements.txt).
If you get an `ssl.CertificateError` complaining about hostname match, your installed packages does not meet version [requirements](requirements.txt).
Specifically check `ipaddress` and `urllib3` package versions to make sure they met requirements in [requirements.txt](requirements.txt) file.

### Why Exec/Attach calls doesn't work

Starting from 4.0 release, we do not support directly calling exec or attach calls. you should use stream module to call them. so instead
of `resp = api.connect_get_namespaced_pod_exec(name, ...` you should call `resp = stream(api.connect_get_namespaced_pod_exec, name, ...`.
See more at [exec example](examples/exec.py).
45 changes: 23 additions & 22 deletions devel/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Release process

Release process of python client involve creating (or updating) a release
branch, update release tags, create distribution packages and upload them to
pip.
The release process of the python client involves creating (or updating) a release
branch, updating release tags, and creating distribution packages and uploading them to
pypi.

## Change logs
Make sure changes logs are up to date [here](https://github.com/kubernetes-client/python/blob/master/CHANGELOG.md).
If they are not, follow commits added after last release and update/commit
Make sure the change logs are up to date [here](https://github.com/kubernetes-client/python/blob/master/CHANGELOG.md).
If they are not, follow commits added after the last release and update/commit
the change logs to master.

Then based on the release, follow one of next two steps.

## Update pre-release branch

Release branch name should have release-x.x format. All minor and pre-releases
should be on the same branch. To update an existing branch with master(only for
The release branch name should have release-x.x format. All minor and pre-releases
should be on the same branch. To update an existing branch with master (only for
latest pre-release):

```bash
Expand All @@ -37,8 +37,8 @@ cherry pick first:
scripts/cherry_pick_pull.sh
```

Do not merge master into an stable releast branch. Run the script without
parameters and follow its instruction to create cherry pick PR and get the
Do not merge master into a stable release branch. Run the script without
parameters and follow its instructions to create a cherry pick PR. Get the
PR merged then update your local branch:

```bash
Expand All @@ -49,26 +49,27 @@ git rebase upstream/$RELEASE_BRANCH
```

## Sanity check generated client
We need to make sure there is no API changes after running update client
scripts. Such changes should be committed to master branch first. Run this

We need to make sure there are no API changes after running update client
scripts. Such changes should be committed to the master branch first. Run this
command:

```bash
scripts/update-client.sh
```

And make sure there is no API change (version number changes should be fine
as they will be updated in next step anyway). Do not commit any changes at
this step and go back to master branch if there is any API changes.
as they will be updated in the next step anyway). Do not commit any changes at
this step and go back to the master branch if there are any API changes.

## Update release tags

Release tags are in scripts/constants.py file. These are the constants you may
Release tags are in the "scripts/constants.py" file. These are the constants you may
need to update:

CLIENT_VERSION: Client version should follow x.y.zDn where x,y,z are version
numbers (integers) and D is one of "a" for alpha or "b" for beta and n is the
pre-release number. For a final release, "Dn" part should be omitted. Examples:
pre-release number. For a final release, the "Dn" part should be omitted. Examples:
1.0.0a1, 2.0.1b2, 1.5.1.

DEVELOPMENT_STATUS: Update it to one of the values of "Development Status"
Expand All @@ -89,8 +90,9 @@ git push upstream $RELEASE_BRANCH
```

## Make distribution packages

First make sure you are using a clean version of python. Use virtualenv and
pyenv packages, make sure you are using python 2.7.12. I would normally do this
pyenv packages. Make sure you are using python 2.7.12. I would normally do this
on a clean machine:

(install [pyenv](https://github.com/yyuu/pyenv#installation))
Expand Down Expand Up @@ -128,9 +130,9 @@ python setup.py bdist_wheel --universal
ls dist/
```

You should see two files in dist folder. kubernetes\*.whl and kubernetes\*.tar.gz.
You should see two files in dist folder: "kubernetes\*.whl" and "kubernetes\*.tar.gz".

TODO: We need a dry-run option an some way to test package upload process to pypi.
TODO: We need a dry-run option and some way to test the package upload process to pypi.

If everything looks good, run this command to upload packages to pypi:

Expand All @@ -142,13 +144,13 @@ twine upload dist/*

Create a gihub release by starting from
[this page](https://github.com/kubernetes-client/python/releases).
Click Deaft new release button. Name the tag the same as CLIENT_VERSION. Change
Click the `Draft a new release button`. Name the tag the same as CLIENT_VERSION. Change
the target branch to "release-x.y". If the release is a pre-release, check the
`This is a pre-release` option.


## Announcement
Send an announcement email to kubernetes-dev@googlegroups.com with the subject [ANNOUNCE] kubernetes python-client $VERSION is released

Send an announcement email to kubernetes-dev@googlegroups.com with the subject: [ANNOUNCE] kubernetes python-client $VERSION is released

## Cleanup

Expand All @@ -159,5 +161,4 @@ rm -rf .release

TODO: Convert steps in this document to an (semi-) automated script.


ref: https://packaging.python.org/distributing/
1 change: 0 additions & 1 deletion devel/stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ LIMIT 20
More example queries can be found [here](https://gist.github.com/alex/4f100a9592b05e9b4d63)

Reference: https://mail.python.org/pipermail/distutils-sig/2016-May/028986.html

14 changes: 8 additions & 6 deletions devel/submodules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
# Submodules

To comply with [client library structure requirement](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/csi-client-structure-proposal.md),
python client base utilities is moved into kubernetes-client/python-base repo. `git submodules` is being used to handle dependency to that repo.
This document will provide basic steps to get submodules work.
python client base utilities is moved into the [kubernetes-client/python-base](https://github.com/kubernetes-client/python-base) repo. `git submodules` is being used to handle dependency to that repo.
This document will provide basic steps to get submodules working.

# Clone repo
To clone repo, you need to pass `recursive` parameter to make the clone also get submodules:

To clone the repo, you need to pass the `recursive` parameter to make the clone also get submodules:

```bash
git clone --recursive https://github.com/kubernetes-client/python.git
```

if you already clone repo with no `--recursive` option, you can run this command to get submodules:
if you have already cloned the repo with no `--recursive` option, you can run this command to get submodules:

```bash
git submodule update --init
```

# Update submodule
If you changed kubernetes-client/python-base and want to pull your changes into this repo run this command:

If you changed [kubernetes-client/python-base](https://github.com/kubernetes-client/python-base) and want to pull your changes into this repo run this command:

```bash
git submodule update --remote
```

Once updated, you should create a new PR to commit changes to the repository.

4 changes: 2 additions & 2 deletions kubernetes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ No description provided (generated by Swagger Codegen https://github.com/swagger

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: v1.14.1
- Package version: 10.0.0a1
- API version: v1.14.4
- Package version: 10.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen

## Requirements.
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

__project__ = 'kubernetes'
# The version is auto-updated. Please do not edit.
__version__ = "10.0.0a1"
__version__ = "10.0.0"

import kubernetes.client
import kubernetes.config
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/base
Open in desktop
Submodule base updated 3 files
+21 −7 config/kube_config.py
+97 −4 config/kube_config_test.py
+1 −1 stream/ws_client.py
2 changes: 1 addition & 1 deletion kubernetes/client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
4 changes: 2 additions & 2 deletions kubernetes/client/api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -73,7 +73,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = 'Swagger-Codegen/10.0.0a1/python'
self.user_agent = 'Swagger-Codegen/10.0.0/python'

def __del__(self):
if self._pool:
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/admissionregistration_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/admissionregistration_v1beta1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apiextensions_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apiextensions_v1beta1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apiregistration_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apiregistration_v1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apiregistration_v1beta1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apis_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apps_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apps_v1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client/apis/apps_v1beta1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1.14.1
OpenAPI spec version: v1.14.4

Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
Loading