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

docs: API specification for CRDs #151

Merged
merged 8 commits into from
Jan 5, 2021

Conversation

Firstsawyou
Copy link
Contributor

close #69

@Firstsawyou Firstsawyou changed the title docs: API specification for CRDs WIP: API specification for CRDs Jan 3, 2021
docs/API-specification.md Outdated Show resolved Hide resolved
docs/API-specification.md Outdated Show resolved Hide resolved
docs/API-specification.md Outdated Show resolved Hide resolved
docs/API-specification.md Outdated Show resolved Hide resolved
docs/API-specification.md Outdated Show resolved Hide resolved
docs/API-specification.md Outdated Show resolved Hide resolved
docs/API-specification.md Outdated Show resolved Hide resolved
@codecov-io
Copy link

codecov-io commented Jan 4, 2021

Codecov Report

Merging #151 (f3cefd3) into master (782730a) will increase coverage by 0.31%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #151      +/-   ##
==========================================
+ Coverage   36.27%   36.59%   +0.31%     
==========================================
  Files          28       28              
  Lines        1257     1257              
==========================================
+ Hits          456      460       +4     
+ Misses        771      767       -4     
  Partials       30       30              
Impacted Files Coverage Δ
pkg/seven/state/solver.go 19.51% <0.00%> (+9.75%) ⬆️

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 782730a...f3cefd3. Read the comment docs.

@Firstsawyou Firstsawyou changed the title WIP: API specification for CRDs docs: API specification for CRDs Jan 4, 2021
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved

# CRD specification

Use the following CRDs to define your routing rules. Normally, you only need to use ApisixRoute to complete a simple route definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not only routing rules, may be "Use the following CRDs to control the behavior of your ingress apisix instances".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gxthrj @tokers
How about this description?
"In order to control the behavior of the proxy (Apache APISIX), the following CRDs should be defined. Normally, you only need to use ApisixRoute to complete a simple route definition."

Copy link
Contributor

Choose a reason for hiding this comment

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

OK , now we have ApisixTls, which is not belong to route. you can remove Normally, you only need to use ApisixRoute to complete a simple route definition.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
docs/CRD-specification.md Outdated Show resolved Hide resolved
@gxthrj gxthrj merged commit 8b65c9d into apache:master Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API specification for CRDs
4 participants