Fix typos and add links to developer guide (#8769)
This commit is contained in:
parent
9dd1029920
commit
6ec425087f
1 changed files with 8 additions and 8 deletions
|
@ -11,7 +11,9 @@ This part of the code is responsible for the main logic of Ingress NGINX. It con
|
||||||
|
|
||||||
### Core Sync Logics:
|
### Core Sync Logics:
|
||||||
|
|
||||||
Ingress-nginx has an internal model of the ingresses, secrets and endpoints in a given cluster. It maintains two copy of that (1) currently running configuration model and (2) the one generated in response to some changes in the cluster.
|
Ingress-nginx has an internal model of the ingresses, secrets and endpoints in a given cluster. It maintains two copies of that:
|
||||||
|
1. currently running configuration model
|
||||||
|
1. the one generated in response to some changes in the cluster
|
||||||
|
|
||||||
The sync logic diffs the two models and if there's a change it tries to converge the running configuration to the new one.
|
The sync logic diffs the two models and if there's a change it tries to converge the running configuration to the new one.
|
||||||
|
|
||||||
|
@ -25,9 +27,7 @@ The following parts of the code can be found:
|
||||||
|
|
||||||
### Entrypoint
|
### Entrypoint
|
||||||
|
|
||||||
Is the `main` package, responsible for starting ingress-nginx program.
|
The `main` package is responsible for starting ingress-nginx program, which can be found in [cmd/nginx](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/nginx) directory.
|
||||||
|
|
||||||
It can be found in [cmd/nginx](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/nginx) directory.
|
|
||||||
|
|
||||||
### Version
|
### Version
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@ Is the package of the code responsible for adding `version` subcommand, and can
|
||||||
|
|
||||||
### Internal code
|
### Internal code
|
||||||
|
|
||||||
This part of the code contains the internal logics that compose Ingress NGINX Controller, and it's split in:
|
This part of the code contains the internal logics that compose Ingress NGINX Controller, and it's split into:
|
||||||
|
|
||||||
#### Admission Controller
|
#### Admission Controller
|
||||||
|
|
||||||
|
@ -54,13 +54,13 @@ This code can be found in [internal/file](https://github.com/kubernetes/ingress-
|
||||||
|
|
||||||
Contains all the logics from NGINX Ingress Controller, with some examples being:
|
Contains all the logics from NGINX Ingress Controller, with some examples being:
|
||||||
|
|
||||||
* Expected Golang structures that will be used in templates and other parts of the codes - [internal/ingress/types.go](https://github.com/kubernetes/ingress-nginx/blob/main/internal/ingress/types.go).
|
* Expected Golang structures that will be used in templates and other parts of the code - [internal/ingress/types.go](https://github.com/kubernetes/ingress-nginx/blob/main/internal/ingress/types.go).
|
||||||
* supported annotations and its parsing logics - [internal/ingress/annotations](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/annotations).
|
* supported annotations and its parsing logics - [internal/ingress/annotations](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/annotations).
|
||||||
* reconciliation loops and logics - [internal/ingress/controller](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/controller)
|
* reconciliation loops and logics - [internal/ingress/controller](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/controller)
|
||||||
* Defaults - define the default struct.
|
* defaults - define the default struct - [internal/ingress/defaults](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/defaults).
|
||||||
* Error interface and types implementation - [internal/ingress/errors](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/errors)
|
* Error interface and types implementation - [internal/ingress/errors](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/errors)
|
||||||
* Metrics collectors for Prometheus exporting - [internal/ingress/metric](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/metric).
|
* Metrics collectors for Prometheus exporting - [internal/ingress/metric](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/metric).
|
||||||
* Resolver - Extracts information from a controller.
|
* Resolver - Extracts information from a controller - [internal/ingress/resolver](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/resolver).
|
||||||
* Ingress Object status publisher - [internal/ingress/status](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/status).
|
* Ingress Object status publisher - [internal/ingress/status](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/status).
|
||||||
|
|
||||||
And other parts of the code that will be written in this document in a future.
|
And other parts of the code that will be written in this document in a future.
|
||||||
|
|
Loading…
Reference in a new issue