You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/01/11 02:37:47 UTC

[GitHub] [apisix-ingress-controller] tokers opened a new issue #167: consummate docs

tokers opened a new issue #167:
URL: https://github.com/apache/apisix-ingress-controller/issues/167


   Here is a basic docs plan
   
   ## Introduction (README)
   * features
   * project status
   * links to other sections
   
   ## Architecture
   * Overview with a picture(each components)
   * Resource translation (diagram + paragraphs)
   
   ## FAQ
   
   ## Concepts of CRDs
   * ApisixRoute
   * ApisixUpstream
   * ApisixService
   * ApisixSSL
   
   ## Get Started
   
   ## Deployment
   * ACK, GKE, AKS, minikube, kind, etc
   * Install by Helm chart
   * Install by Kustomize
   * Install Dashboard (if any)
   * Install Prometheus, Grafana to scrape ingress controller’s metrics
   
   ## Development
   * Steps like build, build-image, run units and e2e tests in local env.
   
   ## Guides
   * Authentication between controller (control plane) and apisix (data plane) with admin key or mTLS.
   * Multiple tenants / clusters
   * Scale controller pods for high availability.
   * ...
   
   
   ## Changelog
   
   ## Contributing
   
   ## Reference
   * Cli options
   * Configueration files
   * CRDs


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix-ingress-controller] gxthrj closed issue #167: consummate docs

Posted by GitBox <gi...@apache.org>.
gxthrj closed issue #167:
URL: https://github.com/apache/apisix-ingress-controller/issues/167


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix-ingress-controller] gxthrj commented on issue #167: consummate docs

Posted by GitBox <gi...@apache.org>.
gxthrj commented on issue #167:
URL: https://github.com/apache/apisix-ingress-controller/issues/167#issuecomment-799309305


   Close this issue, feel free to reopen.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix-ingress-controller] gxthrj commented on issue #167: consummate docs

Posted by GitBox <gi...@apache.org>.
gxthrj commented on issue #167:
URL: https://github.com/apache/apisix-ingress-controller/issues/167#issuecomment-758011808


   Great! I will add some articles on architecture and design with more diagrams.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org