Add the examples to demo listing/creating pods #3

ityuhui · 2020-03-19T02:12:02Z

Add two examples to demo how to use the c client library:

Create a pod
List pods

Because now kuberentes-client/c has no utility such as "config" functions in addition to the source code generated by OpenAPI c generator, these two examples implement the config utility functions in their own source code.

int loadK8sConfigInCluster(char *token, int token_buf_size);
int init_k8s_connector(const char *token_out_of_cluster);

After this PR, I will implement and integrate the config utility to kuberentes-client/c. the same as other language client libraries.

ityuhui · 2020-03-19T02:13:07Z

/cc @brendandburns

brendandburns · 2020-03-19T04:58:05Z

examples/create_pod/main.c

+#include <stdio.h>
+#include <errno.h>
+
+#define K8S_APISERVER_BASEPATH "https://9.111.254.254:6443"


Let's anonymize this with something like "https://your.server.here"

This doesn't seem to have been fixed?

Yes. I have updated but not pushed to Github.

I want to

Prepare a GNU Indent parameter list first and get your reviewed

Use GNU Indent to check my new source

Push the new source code to here for review again.

brendandburns · 2020-03-19T04:58:55Z

examples/create_pod/main.c

+}
+
+int
+loadK8sConfigInCluster(char *token, int token_buf_size)


nit: function on the same line as the return type

brendandburns · 2020-03-19T04:59:04Z

examples/create_pod/main.c

+    return 0;
+}
+
+int


brendandburns · 2020-03-19T04:59:16Z

examples/create_pod/main.c

+    char token_in_cluster[K8S_TOKEN_BUF_SIZE];
+    memset(token_in_cluster, 0, sizeof(token_in_cluster));
+
+    //loadK8sConfigInCluster(token_in_cluster, K8S_TOKEN_BUF_SIZE); // in cluster


delete commented out code.

I put the //loadK8sConfigInCluster here to tell user that how to get config when the program is in a kubernets cluster. It maybe confused.

Deleting it is OK. I can provide another example or function to demo getting config in cluster.

If you add a comment like:

// If you want to load in cluster you would use // loadk8sConfigInCluster(...)

That's fine. As it is currently written it's not quite clear.

brendandburns · 2020-03-19T04:59:24Z

examples/create_pod/main.c

+
+    char valueToken[K8S_TOKEN_BUF_SIZE];
+    memset(valueToken, 0, sizeof(valueToken));
+    //sprintf(valueToken, K8S_AUTH_VALUE_TEMPLATE, token); // in cluster


brendandburns · 2020-03-19T04:59:59Z

examples/list_pod/main.c

+                                            0 /* watch */
+                    );
+    printf("return code=%ld\n", apiClient->response_code);
+    if(pod_list){


nit: spaces between if and (pod_list)

brendandburns · 2020-03-19T05:00:10Z

examples/list_pod/main.c

+            printf("pod name=%s\n", pod->metadata->name);
+        }
+
+    }else{


here too wrt spaces.

brendandburns · 2020-03-19T05:00:24Z

examples/list_pod/main.c

+}
+
+int
+loadK8sConfigInCluster(char *token, int token_buf_size)


function and return type on same line

brendandburns · 2020-03-19T05:00:42Z

examples/list_pod/main.c

+    if (fp == NULL) {
+        if (errno == ENOENT) {
+            printf("\
+%s: The file %s does not exist.",


why is there a line-break here?

No special reason, just want to keep the message text in a dedicated line.

Removing the line-break is OK to me.

brendandburns · 2020-03-19T05:00:56Z

examples/list_pod/main.c

+    char token_in_cluster[K8S_TOKEN_BUF_SIZE];
+    memset(token_in_cluster, 0, sizeof(token_in_cluster));
+
+    //loadK8sConfigInCluster(token_in_cluster, K8S_TOKEN_BUF_SIZE); // in cluster


brendandburns · 2020-03-19T05:01:03Z

examples/list_pod/main.c

+
+    char valueToken[K8S_TOKEN_BUF_SIZE];
+    memset(valueToken, 0, sizeof(valueToken));
+    //sprintf(valueToken, K8S_AUTH_VALUE_TEMPLATE, token); // in cluster


brendandburns · 2020-03-19T05:08:02Z

Thanks for the examples!

I think we need to adopt a style guide for this repo, and add some validation testing to ensure that code matches the style guide.

Do you have any suggestions for a good C style guide? Perhaps Gnu Indent (https://www.gnu.org/software/indent/)

ityuhui · 2020-03-19T06:05:57Z

@brendandburns Thank you for your review. I will update the code by your comment.

And I agree that we should adopt a style guide for this repo. Let me learn and try Gnu Indent.

ityuhui · 2020-03-19T07:03:39Z

Hi @brendandburns

Do you have a preferred GNU Indent parameter list ?
(e.g. -npro -nip -nlp -npsl -i4 -ts4 -sob -l200 -ss -bl -bli 0)

If not, I will prepare a parameter list for your review.

brendandburns · 2020-03-19T15:10:15Z

I don't have a preferred parameter list, let's start with what you suggest.

brendandburns · 2020-03-19T15:41:54Z

Sounds great, let me know when this PR is ready to review again.

Thanks!

1. Anonymize the API server address 2. Remove useless line-break 3. Delete commented out code

ityuhui · 2020-03-20T14:25:34Z

Hi @brendandburns

I have prepared a parameter list of GNU Indent for your review:

Parameter List

-npro -nbad -nip -lp -npsl -npcs -i4 -ts4 -sob -br -ce -nut -bap -nbc -bbo -brs -cs -nfc1 -nfca -hnl -ip0 -nprs -saf -sai -saw -ci4 -cli0 -l200

Detail Description

Option	Description
-npro	Do not read ‘.indent.pro’ files.
-nbad	Do not force blank lines after declarations.
-nip	Zero width indentation for parameters.
-lp	Line up continued lines at parentheses.
-npsl	Put the type of a procedure on the same line as its name.
-npcs	Do not put space after the function in function calls.
-i4	Set indentation level to 4 spaces.
-ts4	Set tab size to 4 spaces.
-sob	Swallow optional blank lines.
-br	Put braces on line with if, etc.
-ce	Cuddle else and preceding ‘}’.
-nut	Use spaces instead of tabs.
-bap	Force blank lines after procedure bodies.
-nbc	Do not force newlines after commas in declarations.
-bbo	Prefer to break long lines before boolean operators.
-brs	Put braces on struct declaration line.
-cs	Put a space after a cast operator.
-nfc1	Do not format comments in the first column as normal.
-nfca	Do not format any comments.
-hnl	Prefer to break long lines at the position of newlines in the input.
-ip0	Indent parameter types in old-style function definitions by 0 spaces.
-nprs	Do not put a space after every '(' and before every ')'.
-saf	Put a space after each for.
-sai	Put a space after each if.
-saw	Put a space after each while.
-ci4	Continuation indent of 4 spaces.
-cli0	Case label indent of 0 spaces.
-l200	Set maximum line length for non-comment lines to 200.

Reference

GNU Indent Document

New Example Code

I have used GNU Indent with this parameter list to generate the new example source code and pushed them here for review again.

brendandburns · 2020-03-20T15:58:58Z

Looks great!

/lgtm
/approve

k8s-ci-robot · 2020-03-20T15:59:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, ityuhui

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [brendandburns,ityuhui]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Add the examples to demo listing/creating pods

cf3729b

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 19, 2020

k8s-ci-robot requested a review from brendandburns March 19, 2020 02:12

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 19, 2020

brendandburns reviewed Mar 19, 2020

View reviewed changes

ityuhui force-pushed the yhworking branch from 06125a2 to cf3729b Compare March 19, 2020 12:42

ityuhui added 2 commits March 20, 2020 16:13

Update examples code:

2502f6b

1. Anonymize the API server address 2. Remove useless line-break 3. Delete commented out code

Update the code style of examples source

9576c62

ityuhui force-pushed the yhworking branch from 0054847 to 9576c62 Compare March 20, 2020 14:14

k8s-ci-robot assigned brendandburns Mar 20, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 20, 2020

k8s-ci-robot merged commit ea2fb24 into kubernetes-client:master Mar 20, 2020

ityuhui mentioned this pull request Mar 24, 2020

Add code style check shell script and style option description #6

Merged

clearday4 mentioned this pull request Mar 19, 2021

double free occurs while calling api in the multi-thread #54

Closed

minerba mentioned this pull request Apr 5, 2021

free Error() #59

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the examples to demo listing/creating pods #3

Add the examples to demo listing/creating pods #3

ityuhui commented Mar 19, 2020

ityuhui commented Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns Mar 19, 2020

ityuhui Mar 19, 2020

brendandburns commented Mar 19, 2020

ityuhui commented Mar 19, 2020

ityuhui commented Mar 19, 2020

brendandburns commented Mar 19, 2020

brendandburns commented Mar 19, 2020

ityuhui commented Mar 20, 2020

brendandburns commented Mar 20, 2020

k8s-ci-robot commented Mar 20, 2020

Add the examples to demo listing/creating pods #3

Add the examples to demo listing/creating pods #3

Conversation

ityuhui commented Mar 19, 2020

ityuhui commented Mar 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brendandburns commented Mar 19, 2020

ityuhui commented Mar 19, 2020

ityuhui commented Mar 19, 2020

brendandburns commented Mar 19, 2020

brendandburns commented Mar 19, 2020

ityuhui commented Mar 20, 2020

Parameter List

Detail Description

Reference

New Example Code

brendandburns commented Mar 20, 2020

k8s-ci-robot commented Mar 20, 2020