alexlebens/external-snapshotter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added go modules for Apis and Client

Browse Source
This commit is contained in:
kartik494
2020-06-25 16:39:59 +05:30
parent d24d2b9820
commit ae215218d1
160 changed files with 3812 additions and 210 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
hack/README.md
View File

@@ -8,50 +8,31 @@ This README documents:
This is the script to update clientset/informers/listers and API deepcopy code using [code-generator](https://github.com/kubernetes/code-generator).
Make sure to run this script after making changes to /pkg/apis/volumesnapshot/v1beta1/types.go.
Make sure to run this script after making changes to /client/apis/volumesnapshot/v1beta1/types.go.
To run this script, you have to patch it:
```patch
diff --git a/hack/update-generated-code.sh b/hack/update-generated-code.sh
--- a/hack/update-generated-code.sh
+++ b/hack/update-generated-code.sh
@@ -27,7 +27,7 @@ CODEGEN_PKG=${CODEGEN_PKG:-$(cd ${SCRIPT_ROOT}; ls -d -1 ./vendor/k8s.io/code-ge
# k8s.io/kubernetes. The output-base is needed for the generators to output into the vendor dir
# instead of the $GOPATH directly. For normal projects this can be dropped.
bash ${CODEGEN_PKG}/generate-groups.sh "deepcopy,client,informer,lister" \
- github.com/kubernetes-csi/external-snapshotter/pkg/client github.com/kubernetes-csi/external-snapshotter/pkg/apis \
+ github.com/kubernetes-csi/external-snapshotter/v2/pkg/client github.com/kubernetes-csi/external-snapshotter/v2/pkg/apis \
volumesnapshot:v1beta1 \
--go-header-file ${SCRIPT_ROOT}/hack/boilerplate.go.txt
```
To run this script, Run: ./hack/update-generated-code.sh from the project root directory.
Once you are done with patching, continue:
Once you run the script, you got the output as:
```bash
rm -fr v2/
ln -sfvn $(pwd) v2
rm -fr pkg/client
Generating deepcopy funcs
Generating clientset for volumesnapshot:v1beta1 at github.com/kubernetes-csi/external-snapshotter/client/v2/clientset
Generating listers for volumesnapshot:v1beta1 at github.com/kubernetes-csi/external-snapshotter/client/v2/listers
Generating informers for volumesnapshot:v1beta1 at github.com/kubernetes-csi/external-snapshotter/client/v2/informers
```
Run: ./hack/update-generated-code.sh from the project root directory.
Do not forget to revert previously applied workaround:
```bash
git checkout -- v2/
git checkout -- hack/update-generated-code.sh
```
## update-crd.sh
This is the script to update CRD yaml files under ./config/crd/ based on types.go file.
This is the script to update CRD yaml files under /client/config/crd/ based on types.go file.
Make sure to run this script after making changes to /pkg/apis/volumesnapshot/v1beta1/types.go.
Make sure to run this script after making changes to /client/apis/volumesnapshot/v1beta1/types.go.
Follow these steps to update the CRD:
* Run ./hack/update-crd.sh from root directory, new yaml files should have been created under ./config/crd/
* Run ./hack/update-crd.sh from client directory, new yaml files should have been created under ./config/crd/
* Replace `api-approved.kubernetes.io` annotation value in all yaml files in the metadata section with your PR.
For example, `api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/YOUR-PULL-REQUEST-#"`
* Add api-approved.kubernetes.io annotation value in all yaml files in the metadata section with the PR where the API is approved by the API reviewers. The current approved PR for snapshot beta API is https://github.com/kubernetes-csi/external-snapshotter/pull/139. Refer to https://github.com/kubernetes/enhancements/pull/1111 for details about this annotation.
* Remove any metadata sections from the yaml file which does not belong to the generated type.
For example, the following command will add a metadata section for a nested object, remove any newly added metadata sections. TODO(xiangqian): this is to make sure the generated CRD is compatible with apiextensions.k8s.io/v1. Once controller-gen supports generating CRD with apiextensions.k8s.io/v1, switch to use the correct version of controller-gen and remove the last step from this README.
@@ -60,3 +41,19 @@ For example, the following command will add a metadata section for a nested obje
+ metadata:
+ description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata'
```
* Update the restoreSize property to string in snapshot.storage.k8s.io_volumesnapshots.yaml
```bash
@@ -160,7 +157,7 @@ spec:
of a snapshot is unknown.
type: boolean
restoreSize:
- - type: string
+ type: string
description: restoreSize represents the complete size of the snapshot
in bytes. In dynamic snapshot creation case, this field will be filled
in with the "size_bytes" value returned from CSI "CreateSnapshotRequest"
```