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.

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

Add docs for plugin development #4276

Merged
merged 3 commits into from
Sep 16, 2019
Merged

Conversation

ajatprabha
Copy link
Contributor

No description provided.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 11, 2019
@codecov
Copy link

codecov bot commented Sep 11, 2019

Codecov Report

Merging #4276 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4276      +/-   ##
==========================================
- Coverage   46.59%   46.56%   -0.03%     
==========================================
  Files         200      200              
  Lines        9373     9365       -8     
  Branches      105      105              
==========================================
- Hits         4367     4361       -6     
+ Misses       4738     4735       -3     
- Partials      268      269       +1
Impacted Files Coverage Δ
...p/backend/integration/metric/common/aggregation.go 89.09% <0%> (-1.82%) ⬇️
...c/app/backend/integration/metric/sidecar/client.go 72% <0%> (-1.69%) ⬇️
src/app/backend/sync/secret.go 73.26% <0%> (+2.97%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 91fbf44...dddde3a. Read the comment docs.

docs/plugins/README.md Outdated Show resolved Hide resolved
@shu-mutou
Copy link
Contributor

@shu-mutou
Copy link
Contributor

Related to #4008.

@ajatprabha
Copy link
Contributor Author

@shu-mutou Should this be mentioned under a separate category or under Developer Guide?

@shu-mutou
Copy link
Contributor

@ajatprabha I think this should be described for third party that includes both of user and developer.

docs/README.md Outdated Show resolved Hide resolved
@maciaszczykm
Copy link
Member

/lgtm
/approve

It's good as a first step. I'd like to have more infor about how to write plugins, what we can use, even some samples with screenshots showing the active plugin in the UI.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 16, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ajatprabha, maciaszczykm

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 16, 2019
@k8s-ci-robot k8s-ci-robot merged commit 63b8327 into kubernetes:master Sep 16, 2019

> Note: The backend reads the compiled plugin source from a ConfigMap and we need to create that also.

### Creating ConfigMap
Copy link

Choose a reason for hiding this comment

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

kubernetes configmap has size limitation, (<=1MB), so the compiled plugin javascript file should not exceed 1MB. That is the limitation of this plugin solution, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, you're right. We can look into other ways to obtain the compiled plugin file instead of just configmap. We wanted to keep dashboard stateless and using configmaps was the easiest way to tackle this for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants