Skip to content

Commit 7f1ca47

Browse files
authored
oke-contributing guideline (#376)
1 parent 0797181 commit 7f1ca47

File tree

2 files changed

+126
-6
lines changed

2 files changed

+126
-6
lines changed

CHANGELOG.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,115 @@
11
# CHANGELOG
22

3+
## v0.13.0
4+
### Major Update
5+
k8s vendor dependencies upgraded to 1.19 from 1.16. Cluster with kubernetes version 1.18 or lesser will not be compatible with any of the components in this release.
6+
7+
### Min required K8s version
8+
1.19
9+
10+
### Features
11+
* ARM support with multiarch images
12+
* OKE (CSI) Expand Volume support. https://github.com/oracle/oci-cloud-controller-manager/blob/master/docs/expand-block-volume-using-csi.md
13+
* Support for tagging OCI LB and BV
14+
* Support Static Provisioning of FSS using CSI Driver with In-transit Encryption. https://github.com/oracle/oci-cloud-controller-manager/blob/master/docs/statically-provisioned-fss-using-csi.md
15+
16+
### Enhancements
17+
* Add arm image support and minor bug fix
18+
* fixed encryption disabled fss tests
19+
* Replaced lbOCID with loadBalancerID in log objects
20+
* Removed hardcoded function and race condition
21+
* Addition of Backendset size dimension to LB metrics
22+
* Added health checks of nodes from pods using a job
23+
* added test to check data integrity on pod restart
24+
25+
### Bug Fixes
26+
* CSI Block Volume - Unexpected formatting when staging target path does not exist and mount fails
27+
* Bug fix for block volume encryption
28+
* Adding error condition when in transit is on and attachment type is iscsi
29+
* Clean exit if mount point is not found and mitigating remove directory error
30+
31+
## v0.13.0-alpha1
32+
33+
## 0.12.0
34+
#### Important points
35+
* NSG Support
36+
* Reserved IP Support
37+
* Kubernetes 1.19 and 1.20 Support
38+
* Bug fixes
39+
#### Summary of changes
40+
* Fix for pod deletion and recreation in fvd test
41+
* removed TCP health check for SSL enabled traffic
42+
* CCM should use LB bulk update API to add /delete backend in backendset
43+
* CCM should stop fetching node and lb subnet in time of LB deletion if CCM is not managing the security list.
44+
* Make all RPCs mutually exclusive
45+
* CCM support for public reserved IP
46+
* Introduce paging to ListVolumes, no limit, filter by display-name
47+
* [CSI] Create targetPath if not already created
48+
* Support for Associating NetworkSecurityGroups to LoadBalancer
49+
* Add resourceName to provision failures to dedupe metrics
50+
* Enable metrics for update operations
51+
* Enable IMDS server lookup
52+
53+
## 0.11.0
54+
55+
* Handle Volume Attachments created in the non-cluster compartment
56+
* Fix nil pointer dereference when node not found by IP
57+
* Add support for updating LB Shape and provisioning of Flexible shape LBs
58+
59+
## 0.10.0
60+
61+
* Service annotation oci-load-balancer-internal: false is not honoured
62+
* CSI - Wait for volume to reach DETACHED state before attempting to attach
63+
* Add unit tests for CSI
64+
* Fix Backup Restore E2E test for multi Attach Error
65+
* Drop iSCSI package installation and add util-linux to the cloud-provider-oci image
66+
67+
## 0.9.0
68+
##### Major changes -
69+
70+
* CSI support
71+
* Regional Subnet support via LB annotation
72+
* Health check config support for backend sets
73+
* Support LB Service creation if nodepool belongs to a different compartment than cluster's compartment
74+
* Bug fixes
75+
76+
##### Detailed changes -
77+
78+
* Kubernetes 1.18 compatibility
79+
* Fix node info controller to trim providerID prefix to support backward compatibility to non-oke clusters.
80+
* CCM should support LB Service creation if nodepool belongs to a different compartment
81+
* CCM should set node address properly to cross compartment node and Fault Domain Label to all the Nodes.
82+
* Opensource CSI in OGHO
83+
* remove wercker references
84+
* CCM is not honouring oci-load-balancer-connection-idle-timeout annotation during update event
85+
* Update seclist when lb service nodeport changes
86+
* Ensure LB SecList is synced if there are no Backend/Backendset/Listerner changes
87+
* merge internal repo commits to oss
88+
* oci-cloud-provider should retry on all retryable errors
89+
* Regional Subnet via LB annotation re-work. Remove subnets annotation and keep old annotaion.
90+
* Support health check config for backend sets.
91+
* Customer should be able to edit the service to add/update listener even if the customer uses the service.beta.kubernetes.io/oci-load- balancer-backend-protocol: "HTTP" 2. When customers add service.beta.kubernetes.io/oci-load-balancer-backend-protocol: "HTTP" in existing service, CCM should update the existing listener with the new protocol( i.e only change the protocol of the listener, not create and delete the listerner)
92+
93+
## 0.8.0
94+
* Kubernetes version 1.14, 1.15, 1.16 and 1.17 support.
95+
* Change documentation as per new release. fix rbac manifest and readme compatibility matrix
96+
* add/delete/update backend servers instead of updating the entire backendsets
97+
* Fix the documentation around how to run e2e tests for CCM
98+
* Fix issues with ccm e2e tests.
99+
* CCM is not honouring oci-load-balancer-connection-idle-timeout annotation during update event
100+
* Change log level to debug for config file not found on worker node
101+
* Fixing CCM build target
102+
* Resolve dependency conflict for Sirupsen by bumping up the version of docker/docker
103+
* CCM should ignore nodes for backends that aren't setup yet.
104+
* move to go mod
105+
* Avoid CCM panic due to index out of range
106+
* update oci-go-sdk
107+
* correction to boilerplate header validation and remove e2e test automation
108+
* Enable provisioning BV from another BV
109+
* Deploy single container with CCM and FVP
110+
* Cert rotation should avoid listener recreation
111+
* Fix test to avoid appending secret name to listeners name
112+
3113
## 0.7.0
4114

5115
* Support assigning SSL certs to BackendSets [#243][30]

CONTRIBUTING.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,33 @@
22

33
*Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.*
44

5+
## Guidelines to raise a PR
6+
7+
### Contributor Agreement
8+
59
Pull requests can be made under
610
[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html)
711
(OCA).
8-
912
For pull requests to be accepted, the bottom of
1013
your commit message must have the following line using your name and
1114
e-mail address as it appears in the OCA Signatories list.
12-
1315
```
1416
Signed-off-by: Your Name <you@example.org>
1517
```
16-
1718
This can be automatically added to pull requests by committing with:
18-
1919
```
2020
git commit --signoff
2121
```
22+
**Only pull requests from committers that can be verified as having
23+
signed the OCA can be accepted.**
24+
25+
### Commit Message
26+
* The commits message should prefix "External-ccm:"
27+
* All commits should be squashed to a single commit before merging
2228

23-
Only pull requests from committers that can be verified as having
24-
signed the OCA can be accepted.
29+
### Best Practices
30+
* Follow the development guidelines [here](docs/development.md)
31+
* govet, golint, gofmt should pass on the PR
32+
* make targets "build" and "test" should be successful on the PR
33+
* E2E should be run on a self managed test cluster, you will have to create a test cluster with the image generated from your changes. Please follow E2E guide [here](test/e2e/cloud-provider-oci/README.md)
34+
* E2E tests should pass on 3 versions of kubernetes currently supported by the repo

0 commit comments

Comments
 (0)