docs(upgrade): Document mapping of ConfigMap and values file

Signed-off-by: Kalya Subramanian <kasubra@microsoft.com>

docs/content/docs/osm_config_map.md

@@ -10,16 +10,16 @@ OSM deploys a configMap `osm-config` as a part of its control plane (in the same
 
 ## ConfigMap Values
 
-| Key | Type | Allowed Values | Default Value | Function |
-|-----|------|-----------------|---------------|----------|
-| permissive_traffic_policy_mode | bool | true, false | `"false"` | Setting to `true`, enables allow-all mode in the mesh i.e. no traffic policy enforcement in the mesh. If set to `false`, enables deny-all traffic policy in mesh i.e. an `SMI Traffic Target` is necessary for services to communicate. |
-| egress | bool | true, false| `"false"` | Enables egress in the mesh. |
-| enable_debug_server | bool | true, false| `"true"` | Enables a debug endpoint on the osm-controller pod to list information regarding the mesh such as proxy connections, certificates, and SMI policies. |
-| envoy_log_level | string | trace, debug, info, warning, warn, error, critical, off | `"error"` | Sets the logging verbosity of Envoy proxy sidecar, only applicable to newly created pods joining the mesh. |
-| prometheus_scraping | bool | true, false | `"true"` | Enables Prometheus metrics scraping on sidecar proxies. |
-| service_cert_validity_duration | string | 24h, 1h30m (any time duration) | `"24h"` | Sets the service certificatevalidity duration, represented as a sequence of decimal numbers each with optional fraction and a unit suffix. |
-| tracing_enable | bool | true, false | `"true"` | Enables Jaeger tracing for the mesh. |
-| tracing_address | string | jaeger.mesh-namespace.svc.cluster.local | `jaeger.osm-system.svc.cluster.local` | Address of the Jaeger deployment, if tracing is enabled. |
-| tracing_endpoint | string | /api/v2/spans | /api/v2/spans | Endpoint for tracing data, if tracing enabled. |
-| tracing_port| int | any non-zero integer value | `"9411"` | Port on which tracing is enabled. |
-| use_https_ingress | bool | true, false | `"false"`| Enables HTTPS ingress on the mesh. |
+| Key | Chart Value |Type | Allowed Values | Default Value | Function |
+|-----|-------------|------|-----------------|---------------|----------|
+| permissive_traffic_policy_mode | OpenServiceMesh.enablePermissiveTrafficPolicy | bool | true, false | `"false"` | Setting to `true`, enables allow-all mode in the mesh i.e. no traffic policy enforcement in the mesh. If set to `false`, enables deny-all traffic policy in mesh i.e. an `SMI Traffic Target` is necessary for services to communicate. |
+| egress | OpenServiceMesh.enableEgress | bool | true, false| `"false"` | Enables egress in the mesh. |
+| enable_debug_server | OpenServiceMesh.enableDebugServer | bool | true, false| `"true"` | Enables a debug endpoint on the osm-controller pod to list information regarding the mesh such as proxy connections, certificates, and SMI policies. |
+| envoy_log_level | OpenServiceMesh.envoyLogLevel | string | trace, debug, info, warning, warn, error, critical, off | `"error"` | Sets the logging verbosity of Envoy proxy sidecar, only applicable to newly created pods joining the mesh. |
+| prometheus_scraping | OpenServiceMesh.enablePrometheusScraping | bool | true, false | `"true"` | Enables Prometheus metrics scraping on sidecar proxies. |
+| service_cert_validity_duration | OpenServiceMesh.serviceCertValidityDuration | string | 24h, 1h30m (any time duration) | `"24h"` | Sets the service certificatevalidity duration, represented as a sequence of decimal numbers each with optional fraction and a unit suffix. |
+| tracing_enable | OpenServiceMesh.tracing.enable | bool | true, false | `"true"` | Enables Jaeger tracing for the mesh. |
+| tracing_address | OpenServiceMesh.tracing.address | string | jaeger.mesh-namespace.svc.cluster.local | `jaeger.osm-system.svc.cluster.local` | Address of the Jaeger deployment, if tracing is enabled. |
+| tracing_endpoint | OpenServiceMesh.tracing.endpoint | string | /api/v2/spans | /api/v2/spans | Endpoint for tracing data, if tracing enabled. |
+| tracing_port| OpenServiceMesh.tracing.port | int | any non-zero integer value | `"9411"` | Port on which tracing is enabled. |
+| use_https_ingress | OpenServiceMesh.useHTTPSIngress | bool | true, false | `"false"`| Enables HTTPS ingress on the mesh. |

docs/upgrade_guide.md

@@ -28,7 +28,9 @@ When upgrading, any custom settings used to install or run OSM may be reverted t
 Use the `helm` CLI to upgrade the OSM control plane.
 
 ### Preserve OSM configuration
-To preserve any changes you've made to the OSM configuration, use the `helm --values` flag. Create a copy of the [values file](https://github.com/openservicemesh/osm/blob/main/charts/osm/values.yaml) (make sure to use the version for the upgraded chart) and change any values you wish to customize.
+To preserve any changes you've made to the OSM configuration, use the `helm --values` flag. Create a copy of the [values file](https://github.com/openservicemesh/osm/blob/main/charts/osm/values.yaml) (make sure to use the version for the upgraded chart) and change any values you wish to customize. You can omit all other values.
+
+To see which values correspond to the ConfigMap settings, see the [OSM ConfigMap documentation](osm_config_map.md)
 
 For example, to keep the `envoy_log_level` field in the ConfigMap set to `info`, save the following as `override.yaml`:
 
@@ -43,6 +45,6 @@ Then run the following `helm upgrade` command.
 ```console
 $ helm upgrade <mesh name> osm --repo https://openservicemesh.github.io/osm --version <chart version> --namespace <osm namespace> --values override.yaml
 ```
-Omit the `--values` flag if you prefer to use the default settings.
+Omit the `--values` flag if you prefer to use the default settings, but please note this could override any edits you've made to the ConfigMap.
 
 Run `helm upgrade --help` for more options.