-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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: update remaining sections in config-default.yaml
#9658
Conversation
conf/config-default.yaml
Outdated
# on the available system resources. | ||
# If you want use multiple cores in container, you can inject the number of | ||
# CPU cores as environment variable "APISIX_WORKER_PROCESSES". | ||
enable_cpu_affinity: false # Disable CPU affinity by default as worker_cpu_affinity affects the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Referenced #8042 and https://nginx.org/en/docs/ngx_core_module.html#worker_cpu_affinity for CPU affinity
skywalking: # Plugin: skywalking | ||
service_name: APISIX # Set the service name for SkyWalking reporter. | ||
service_instance_name: APISIX Instance Name # Set the service instance name for SkyWalking reporter. | ||
endpoint_addr: http://127.0.0.1:12800 # Set the SkyWalking HTTP endpoint. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to merge #9662 if report_interval
indeed needs to be added
# admin_api_mtls: # Set this if `https_admin` is true. | ||
# admin_ssl_cert: "" # Set path to SSL/TLS certificate. | ||
# admin_ssl_cert_key: "" # Set path to SSL/TLS key. | ||
# admin_ssl_ca_cert: "" # Set path to CA certificate used to sign client certificates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
#https_admin: true # enable HTTPS when use a separate port for Admin API.
# Admin API will use conf/apisix_admin_api.crt and conf/apisix_admin_api.key as certificate.
admin_api_mtls: # Depends on `admin_listen` and `https_admin`.
admin_ssl_cert: "" # Path of your self-signed server side cert.
admin_ssl_cert_key: "" # Path of your self-signed server side key.
admin_ssl_ca_cert: "" # Path of your self-signed ca cert.The CA is used to sign all admin api callers' certificates.
to
# https_admin: true # Enable SSL for Admin API on IP and port specified in admin_listen.
# Use admin_api_mtls.admin_ssl_cert and admin_api_mtls.admin_ssl_cert_key.
# admin_api_mtls: # Set this if `https_admin` is true.
# admin_ssl_cert: "" # Set path to SSL/TLS certificate.
# admin_ssl_cert_key: "" # Set path to SSL/TLS key.
# admin_ssl_ca_cert: "" # Set path to CA certificate used to sign client certificates.
with reference to ngx_tpl.lua
:
server {
{%if https_admin then%}
listen {* admin_server_addr *} ssl;
ssl_certificate {* admin_api_mtls.admin_ssl_cert *};
ssl_certificate_key {* admin_api_mtls.admin_ssl_cert_key *};
{%if admin_api_mtls.admin_ssl_ca_cert and admin_api_mtls.admin_ssl_ca_cert ~= "" then%}
ssl_verify_client on;
ssl_client_certificate {* admin_api_mtls.admin_ssl_ca_cert *};
{% end %}
tls: | ||
# To enable etcd client certificate you need to build APISIX-Base, see | ||
# https://apisix.apache.org/docs/apisix/FAQ#how-do-i-build-the-apisix-base-environment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These descriptions were removed because by default, APISIX is built on APISIX-Base.
# To enable etcd client certificate you need to build APISIX-Base, see
# https://apisix.apache.org/docs/apisix/FAQ#how-do-i-build-the-apisix-base-environment
@navendu-pottekkat please help to check |
Co-authored-by: Liu Wei <375636559@qq.com>
@kayx23 please fix the lint error |
* upstream/master: chore(deps): bump golang.org/x/text (apache#8924) chore(deps): bump google.golang.org/grpc in /t/plugin/grpc-web (apache#9787) docs: fix typo in pubsub.md (apache#9799) ci: add check for broken links (apache#9760) docs: update config-default.yaml (apache#9658)
Description
Update comments/documentations in config-default.yaml as the file is referenced in new docs.
This PR includes the remaining updates for #9611
No functional changes in these PRs.
Checklist