Skip to content
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

Jump to bottom

enhancement: add configmap to configure user agents for specify response cache. #466

Merged
merged 1 commit into from
Sep 13, 2021
Merged

enhancement: add configmap to configure user agents for specify response cache. #466

merged 1 commit into from
Sep 13, 2021

Conversation

rambohe-ch
Copy link
Member

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:
/kind bug
/kind documentation
/kind enhancement
/kind good-first-issue
/kind feature
/kind question
/kind design
/sig ai
/sig iot
/sig network
/sig storage
/sig storage

/kind feature

What this PR does / why we need it:

  • background:
    At present, only response for requests from fixed user agents(like kube-proxy, flanneld, coredns, kubelet, yurthub, yurt-tunnel-agent) can be cached in local disk by yurthub. if user's pod access kube-apiserver through yurthub, the response can not be cached on local disk for user agents can not be recognized.

  • solution:

    1. It's not good idea to enable cache all response for requests through yurthub, because some clients only want to access kube-apiserver or some list requests may get large volume data and make pressure to local disk.
    2. So we add an configmap named yurt-hub-cfg with cache_agents field in kube-system namespace, user can add request user agent in this field.
    3. For example, calico components want to access kube-apiserver through yurthub and want to use yurthub cache ability, you can configure as following:
apiVersion: v1
kind: ConfigMap
metadata:
  name: yurt-hub-cfg
  namespace: kube-system
data:
  cache_agents: "calico"

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

other Note

@openyurt-bot
Copy link
Collaborator

@rambohe-ch: GitHub didn't allow me to assign the following users: your_reviewer.

Note that only openyurtio members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:
/kind bug
/kind documentation
/kind enhancement
/kind good-first-issue
/kind feature
/kind question
/kind design
/sig ai
/sig iot
/sig network
/sig storage
/sig storage

/kind feature

What this PR does / why we need it:

  • background:
    At present, only response for requests from fixed user agents(like kube-proxy, flanneld, coredns, kubelet, yurthub, yurt-tunnel-agent) can be cached in local disk by yurthub. if user's pod access kube-apiserver through yurthub, the response can not be cached on local disk for user agents can not be recognized.

  • solution:

  1. It's not good idea to enable cache all response for requests through yurthub, because some clients only want to access kube-apiserver or some list requests may get large volume data and make pressure to local disk.
  2. So we add an configmap named yurt-hub-cfg with cache_agents field in kube-system namespace, user can add request user agent in this field.
  3. For example, calico components want to access kube-apiserver through yurthub and want to use yurthub cache ability, you can configure as following:
apiVersion: v1
kind: ConfigMap
metadata:
 name: yurt-hub-cfg
 namespace: kube-system
data:
 cache_agents: "calico"

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

other Note

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openyurt-bot openyurt-bot added the kind/feature kind/feature label Sep 10, 2021
@openyurt-bot openyurt-bot added the approved approved label Sep 10, 2021
@rambohe-ch
Copy link
Member Author

/assign @Fei-Guo

@openyurt-bot openyurt-bot added the size/L size/L: 100-499 label Sep 10, 2021
Fei-Guo
Fei-Guo reviewed Sep 10, 2021
View reviewed changes
pkg/yurthub/cachemanager/cache_agent.go
oldAgents := cm.cacheAgents.Delete(util.DefaultCacheAgents...)

if oldAgents.Equal(newAgents) {
return sets.String{}
Copy link
Member

Choose a reason for hiding this comment

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

Should you add the DefaultCacheAgents back before returning sets.String{} here and for constructing new cache agents below?

Copy link
Member Author

Choose a reason for hiding this comment

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

Should you add the DefaultCacheAgents back before returning sets.String{} here and for constructing new cache agents below?

fixed, DefaultCacheAgents have been added.

@rambohe-ch
enhancement: add configmap to configure user agents for specify respo…
6c40884 
…nse cache.

- background:
At present, only response for requests from fixed user agents(like kube-proxy, flanneld, coredns, kubelet, yurthub, yurt-tunnel-agent) can be cached in local disk by yurthub. if user's pod access kube-apiserver through yurthub, the response can not be cached on local disk for user agents can not be recognized.

- solution:
1. It's not good idea to enable cache all response for requests through yurthub, because some clients only want to access kube-apiserver or some list requests may get large volume data and make pressure to local disk.
2. So we add an configmap named yurt-hub-cfg with `cache_agents` field in kube-system namespace, user can add request user agent in this field.
3. For example, `calico` components want to access kube-apiserver through yurthub and want to use yurthub cache ability, you can configure as following:

```
apiVersion: v1
kind: ConfigMap
metadata:
  name: yurt-hub-cfg
  namespace: kube-system
data:
  cache_agents: "calico"

```
@rambohe-ch rambohe-ch force-pushed the add-cache-configuration branch from 14df997 to 6c40884 Compare September 12, 2021 14:09
@Fei-Guo
Copy link
Member

Fei-Guo commented Sep 13, 2021

/lgtm
/approve

@openyurt-bot openyurt-bot added the lgtm lgtm label Sep 13, 2021
@openyurt-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Fei-Guo, rambohe-ch

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:

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

@openyurt-bot openyurt-bot merged commit 392c206 into openyurtio:master Sep 13, 2021
MrGirl pushed a commit to MrGirl/openyurt that referenced this pull request Mar 29, 2022
@rambohe-ch
enhancement: add configmap to configure user agents for specify respo…
3739d19 
…nse cache. (openyurtio#466)

- background:
At present, only response for requests from fixed user agents(like kube-proxy, flanneld, coredns, kubelet, yurthub, yurt-tunnel-agent) can be cached in local disk by yurthub. if user's pod access kube-apiserver through yurthub, the response can not be cached on local disk for user agents can not be recognized.

- solution:
1. It's not good idea to enable cache all response for requests through yurthub, because some clients only want to access kube-apiserver or some list requests may get large volume data and make pressure to local disk.
2. So we add an configmap named yurt-hub-cfg with `cache_agents` field in kube-system namespace, user can add request user agent in this field.
3. For example, `calico` components want to access kube-apiserver through yurthub and want to use yurthub cache ability, you can configure as following:

```
apiVersion: v1
kind: ConfigMap
metadata:
  name: yurt-hub-cfg
  namespace: kube-system
data:
  cache_agents: "calico"

```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Fei-Guo Fei-Guo Fei-Guo left review comments

@Peeknut Peeknut Awaiting requested review from Peeknut

@yixingjia yixingjia Awaiting requested review from yixingjia

Assignees

@Fei-Guo Fei-Guo

Labels
approved approved kind/feature kind/feature lgtm lgtm size/L size/L: 100-499
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rambohe-ch @openyurt-bot @Fei-Guo