📃 Improve README with more information. (#15)

kintoproj · Feb 11, 2021 · f6b3b51 · f6b3b51
1 parent d155c9e
commit f6b3b51
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -10,12 +10,34 @@
 * Kubernetes version `1.16` or higher
 
 ## Dependencies
-- [utils-go](https://github.com/kintohub/utils-go) our own reuseable utils functions
+- [utils-go](https://github.com/kintohub/utils-go) our own reusable utils functions
+
+## Configuration
+
+The following table lists the configurable parameters of the core and their default values.
+
+|            Parameter              |                                  Description                               |                           Default                        | Required |
+|-----------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------|----------|
+| `LOG_LEVEL`                       | Log levels from `verbose` to `panic`                                       | `debug`                                                  |          |
+| `KUBE_CONFIG_PATH`                | Only for local development                                                 |                                                          |          |
+| `GRPC_PORT`                       | GRPC port                                                                  | `8080`                                                   |          |
+| `GRPC_WEB_PORT`                   | GRPC web port                                                              | `8090`                                                   |          |
+| `CORS_ALLOWED_HOST`               | Specify the hosts allowed to call the server                               | `*`                                                      |          |                        
+| `CONSOLE_LOGS_HISTORY_SECONDS`    | Max time in seconds to query the logs                                      | `86400`                                                  |          |
+| `CONSOLE_LOGS_MAX_LINES_ON_START` | Max number of lines to query the logs                                      | `1000`                                                   |          |
+| `METRICS_UPDATE_TICK_SECONDS`     | Refresh frequency in seconds for querying the metrics                      | `5`                                                      |          |
+| `HEALTH_UPDATE_TICK_SECONDS`      | Refresh frequency in seconds for querying the health of the services       | `1`                                                      |          |
+| `KINTO_DOMAIN`                    | Domain/Subdomain used to create external name for api and web app services |                                                          | Yes      |
+| `BUILD_API_HOST`                  | `kinto-builder` api host                                                   | `kinto-builder:8080`                                     |          |
+| `CERT_MANAGER_ISSUER_EMAIL`       | Email used on every certificate for every external service                 |                                                          | Yes      |
+| `CERT_MANAGER_ISSUER_SERVER`      | Let's encrypt server                                                       | `https://acme-staging-v02.api.letsencrypt.org/directory` |          |
+| `KINTO_DEV_PROXY_ENABLED`         | Is kinto-cli allowed to connect                                            | `true`                                                   |          |
+| `PROXLESS_FQDN`                   | Proxless kubernetes FQDN                                                   | `kinto-proxless.kintohub.svc.cluster.local`              |          |
 
 ## Development Setup
 
 Duplicate the `.env.example` file into a `.env` file.  
-Modify the variables if needed.
+Modify the variables if needed. See configuration above for more information.
 
 ```shell script
 $ go run cmd/main.go
@@ -35,6 +57,4 @@ We use [BloomRPC](https://github.com/uw-labs/bloomrpc)
 
 ## Meta
 
-KintoHub Goons - [@KintoHub](https://twitter.com/kintohub)
-
 https://www.kintohub.com
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -43,7 +43,7 @@ func InitConfig() {
 	BuildApiHost = utilsGoConfig.GetString("BUILD_API_HOST", "kinto-builder:8080")
 
 	CertManagerIssuerEmail = utilsGoConfig.GetStringOrDie("CERT_MANAGER_ISSUER_EMAIL")
-	CertManagerIssuerServer = utilsGoConfig.GetStringOrDie("CERT_MANAGER_ISSUER_SERVER")
+	CertManagerIssuerServer = utilsGoConfig.GetString("CERT_MANAGER_ISSUER_SERVER", "https://acme-staging-v02.api.letsencrypt.org/directory")
 
 	KintoDevProxyEnabled = utilsGoConfig.GetBool("KINTO_DEV_PROXY_ENABLED", true)
 	ProxlessFQDN = utilsGoConfig.GetString("PROXLESS_FQDN", "kinto-proxless.kintohub.svc.cluster.local")