Milestone v0.8.0 planning

[michelleN]

Please comment with links to issues that you feel should be tackled in the v0.8.0 release cycle

[michelleN]

#685

[draychev]

ref #2316

[shashankram]

Consolidated list:

• SMI crd management #685
• App container startup issue if startup depends on network connectivity via sidecar proxy #2316
• Retest HTTPS ingress and update documentation #2115
• e2e test for HTTP ingress #2327
• Harden ingress security by using per ingress resource backend protocol configuration #2365
• #2356
• OSM CLI and Chart version compatibility #2293
• Installation GIF is outdated #2279
• Document installing/uninstalling OSM via helm CLI #2197

[michelleN]

#2364

[nojnhuh]

SMI Metrics:

• Implement SMI Metrics #379
• Extend Envoy to get custom metrics needed to implement smi metrics #984
• Implement SMI metrics API server #1540

[snehachhabria]

#2363
#2263
#2218
#2097
#1892
#1860
#705

Finish the remaining work in routes refactor:
#2048
#2038

If SMI metrics is a part of 0.8 I think we can incorporate this issue too :
#1671

[michelleN]

https://github.com/openservicemesh/osm/issues/2310

[ritazh]

#2386

[draychev]

Candidates for v0.8

• Tooling & CLI

  • Create an endpoint returning mesh data plane health #1718 - tooling, health, endpoint
  • OSM CLI and Chart version compatibility #2293 - cli
  • Create an osm command that allows a user to check if an osm control plane is healthy #85 - cli, health
  • Add a validation ensuring we are not adding Envoy sidecar to an already meshed pod #1717 - tooling, validation
  • OSM CLI: provide a way to toggle ConfigMap permissive_traffic_policy_mode true/false #1855 - tooling, cli, permissive mode
  • CLI to list meshes should show additional context: k8s cluster, controller pods #1841 - tooling, cli, add context
  • Use an intermediate certificate to sign all service-to-service mTLS certs #507 - intermediate certificate
  • Migrate from ptypes.MarshalAny to a deterministic MarshalAny function to stabilize tests #878 - deterministic serialization
  • CLI delete behavior undefined when more than one OSM w same name on cluster #1839 - tooling, cli, delete
  • expose osm-controller version #1152 - debug, tooling
  • update osm-controller/control plane configuration via the osm cli #1139 - configuration, cli
  • osm command for verifying mTLS connection between two services #1388 - cli, tooling, mTLS, verification

• Upgrades

  • How does OSM upgrade handle SMI version upgrades on a cluster with existing policies? #893 - upgrades
  • Add check in the OSM CLI for available updates / upgrades / new versions #1720 - tooling, cli, upgrade

• Metrics

  • Implement minimum set of Prometheus metrics for OSM Controller pod #902 - metrics
  • add verbose output for osm install with -v flag #912 - osm install cli verbose output

• Observability

  • https://github.com/openservicemesh/osm/issues/917 - observability, documentation
  • Implement distributed tracing w/ Jaeger and Envoy header forwarding #1921 - observability, distributed tracing

• Refactor & Cleanup

  • Move SDS specific definitions from xdsutils to SDS #971 (refactor) -- close?
  • GetHostnamesForUpstreamService should replace GetResolvableHostnamesForUpstreamService  #2048 - refactor, consolidate
  • should mesh-name be control-plane-name? #1140 - rename, refactor
  • remove isValidTrafficTarget after tackling validating SMI resources more generally #2052 - refactor, remove
  • Converge on uniform terminology for destination / remote / outbound / downstream / server #1860 - refactor, uniformity
  • make "service" terminology more clear across repo #979 - refactor, uniformity, clarity
  • consolidate GetServicesForServiceAccounts and GetServicesForServiceAccount #2038 - refactor, consolidate
  • Add support for WebAssembly filters #1671 - refactor
  • Program envoy to use list of services returned by GetServicesFromEnvoyCertificate #1575 - refactor
  • Move GetResolvableServiceEndpoints to be endpoint-provider specifc #1655 - refactor
  • refactor how inbound and outbound VirtualHosts are programmed on Envoy proxies #2034 - refactor
  • add package comment to all packages #1038 - refactor, comments, packages
  • Consolidate cmd/cli errors into errors.go file #1189 - refactor, errors
  • Refactor code so that ads can be configured with CertificateStore and a CertificateManager.  #1034 - refactor, ads, interfaces
  • rename mesh top level command to control-plane #1150 - rename, refactor

• Ingress

  • Configure ALPN for external clients using ingress #1020 - ingress, alpn
  • Harden ingress security by using per ingress resource backend protocol configuration #2365 - ingress
  • Retest HTTPS ingress and update documentation #2115 - documentation, https, ingress
  • Allow wildcard HTTP inbound traffic with permissive mode #1461 - ingress
  • e2e test for HTTP ingress #2327 - ingress, e2e
  • Harden ingress security by using per ingress resource backend protocol configuration #2365 - ingress
  • Retest HTTPS ingress and update documentation #2115 - documentation, https ingress

• Scalability & High Availability of Control Plane

  • create a framework for measuring performance and scalability of an osm control plane #1916 - scalability, measurement tooling
  • Measure performance and scalability of OSM control plane #1723 - scalability, measure, document
  • perf bottleneck at 400 pod scale (ADS times++), Rlock resource contention on K8s Namespace cache #1958 - scalability, perf, bottleneck
  • Optimize announcement channels and XDS config push in osm-controller #1913 - scalability, announcements

• Documentation

  • create a troubleshooting guide #1488 - documentation, troubleshooting guide
  • Document Envoy error messages when traffic is blocked via an SMI policy #1085 - document, debug, Envoy
  • https://github.com/openservicemesh/osm/issues/1919 - documentation, tracing
  • https://github.com/openservicemesh/osm/issues/2356 - documentation
  • add instructions for manually testing traffic encryption in example usage guide #1390 - documentation, demo, mTLS
  • https://github.com/openservicemesh/osm/issues/1983 - documentation, traffic split, apex
  • https://github.com/openservicemesh/osm/issues/2008 - documentation, organize
  • Document installing/uninstalling OSM via helm CLI #2197 - documentation, helm
  • Installation GIF is outdated #2279 - documentation
  • https://github.com/openservicemesh/osm/issues/2356 - documentation
  • Document User ID and ports used by OSM #2106 - documentation, ports
  • Document the statelessness of OSM Controller #2126 - documentation, statelessness
  • Document how to upgrade OSM #2151 - documentation, upgrades
  • Create documentation site: openservicemesh.io/docs #1678 - documentation, site

• Integrations

  • Not working with dapr #1420 - integration, dapr
  • Observability: Integration with AZure monitor #1511 - integration, AzMon
  • Integrate OSM with OPA envoy plugin #1874 - integration, opa

• Identity

  • Decouple Identity of payload from Service Account #1681 - identity, service account
  • Use ServiceIdentity type in catalog APIs instead of service.K8sServiceAccount #2218 - identity, refactor

• Bootstrap

  • Overriding default ADS port is not reflected in proxy bootstrap config #2190 - bootstrap, config, ports
  • osm install does not work on AKS with integrated AAD #1670 - bootstrap, iptables, dynamic
  • App container startup issue if startup depends on network connectivity via sidecar proxy #2316 - bootstrap, health, payload network access
  • injector: Allow for customizations of iptables config based on OSM Controller observed context #2344 - bootstrap, iptables, customize
  • Handle app calls with proxy_uid in iptable rules #1266 - bootstrap, iptables

• Metrics

  • Implement SMI Metrics #379 - metrics
  • Extend Envoy to get custom metrics needed to implement smi metrics #984 - metrics
  • Implement SMI metrics API server #1540 - metrics

• Bugs

  • When you unjoin all namespaces from the mesh - curling bookstore.bookstore:8080 does not work #1181 - bug, demo, smi
  • Failing local service cluster with target port of service #1975 - bug
  • Apex service of traffic split selecting a pod is programmed as a cluster by RDS #1979 - bug, apex, traffic split
  • cluster_not_found occurs when multi services existing of one application #2134 - bug, xds
  • Destination endpoints for a service that maps to multiple ServiceAccounts doesn't honor TrafficTarget policy #1658 - bug, xds
  • helm upgrade overrides manual edits in osm-config #2386 - helm, bug
  • In permissive traffic mode (allow-all) only pods with services can communicate; not individual pods w/ service #2064 - bug, permissive, no service pods

• Developer Experience

  • Binaries built outside of the Dockerfiles #2078 - developer tools
  • Provide capability to install with Chocolatey #1426 - tooling, chocolatey

• Everything else

  • Design a high level plan for multicluster with osm #1892 - arch, design, multicluster
  • ci: Prevent typos from sneakin ginto the repository #1407 - prevent typos, ci
  • Support per port traffic target policies for a destination #1508 - xds, policies
  • Make pkg/catalog Ticker announcement channel configurable #1501 - configuration, ticker, Envoy
  • (root) Improve test coverage (goal: 80%) #1489 - test
  • Make certificate key bit size configurable #1933 - configuration, cert size
  • Redesign Envoy config creation, caching and distribution #1938 - arch, design, Envoy config creation
  • Webhook/certificate generation split from XDS control plane #1939 - arch, split webhooks
  • Allow users to provide a CA bundle for configuring the mutatingWebhookConfiguration in OSM #1974 - configuration, user-provided ca
  • Allow a way to not enforce client side routes to simplify gradual migration of applications into the mesh #2012 - xds, optional client-side routes
  • Implement Hashcorp Vault delete-certificate API call #2068 - integrations, vault, mTLS, delete cert
  • Program ip:port combinations as possible host headers in virtual_host.domains for HTTP routes #2097 - xds, ip port combinations on routes
  • Make OSM control plane instances upgradeable #2100 - upgrades
  • Add runtime config/osm boot flags to configure ticker/resyncs #2103 - configuration, ticker
  • Make Prometheus deployment optional and enable compatibility with Prometheus Operator #1537 - configuration, documentation, prometheus optional
  • Envoy must expose health probes of underlying service  #2207 - xds, health probes
  • Create an endpoint that returns versions of SMI APIs that the osm-controller supports #1590 - health, debug, endpoint, version
  • Ensure these failures and important events are being logged by osm-controller #2364 - debug, logging
  • Add a reconciler for the OSM CA Bundle secret  #2022 - osm secret reconciler
  • update go version to 1.15.7 #2363 - update go
  • Use XDS structs and marshal to JSON while creating Envoy bootstrap config #2263 - xds to json
  • Update TrafficSplit version from v1alphav2 to v1alpha4 #705 - smi, update
  • SMI crd management #685 - smi
  • OSM consistency checker for mesh health and mesh configuration on the proxies. #2099 - health

clean up:

• osm command to register new endpoint provider #94 - close
• how to bootstrap a VM in the service mesh #286 - close
• end user facing documentation for onboarding a VM into the mesh #178 - close
• OSM Control Plane Scalability (integrate w/ Lyft's XDS relay) #291 - close
• (can we) Enable mTLS between prometheus endpoints and prometheus  #836 - close
• Cross namespace ingress support #892 - close
• make "service" terminology more clear across repo #979 - close
• move AzureResource CRD to helm chart and move docs to docs/ #1041 - close

check status:

• refactor how inbound and outbound VirtualHosts are programmed on Envoy proxies #2034
• Update osm-controller rbac to allow it to watch, list, read AzureResource objects in Kubernetes. Remove dependency on kubeconfig file. #1037
• https://github.com/openservicemesh/osm/issues/1058 - can we close it? If not - add it to v0.8 so we can close this
• Secure the scraping of Envoys by Prometheus #1167 - ?
• Document how to run maestro locally #1710 - this could be closed

[michelleN]

#2390
#2392

[michelleN]

#2393
#2394

[snehachhabria]

I'd like to have the routes refactor completed and ready for cut-over by the end of this milestone. The issues needed to achieve this are :
https://github.com/openservicemesh/osm/issues?q=is%3Aopen+is%3Aissue+label%3A%22routes+v2%22

[SanyaKochhar]

#2159

[ritazh]

https://github.com/openservicemesh/osm/issues/2414
#2424

[fredstanley]

#1045 - HA for osm controller

[snehachhabria]

Milestone 0.8 planning was completed a while ago