Add notes on using gloo with Zipkin and Jaeger

relevant config shown below

zipkin install

---
apiVersion: v1
kind: Service
metadata:
  name: zipkin
  namespace: default
spec:
  selector:
    app: zipkin
  ports:
  - port: 9411
    name: http
    targetPort: http
  type: NodePort
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: zipkin
  namespace: default
spec:
  replicas: 1
  strategy:
    type: RollingUpdate
  template:
    metadata:
      labels:
        app: zipkin
    spec:
      containers:
      - name: zipkin
        image: openzipkin/zipkin
        imagePullPolicy: Always
        ports:
        - name: http
          containerPort: 9411

gateway spec

...
spec:
  httpGateway:
    plugins:
      httpConnectionManagerSettings:
        tracing:
          verbose: true
...

config map

kind: ConfigMap
metadata:
  name: gateway-proxy-v2-envoy-config
  namespace: gloo-system
apiVersion: v1
data:
  envoy.yaml: |
    tracing:
      http:
        name: envoy.zipkin
        config:
          trace_id_128bit: true
          collector_cluster: tracingcluster
          collector_endpoint: "/api/v1/spans"
          shared_span_context: false
    static_resources:
      clusters:
      - name: tracingcluster
        alt_stat_name: trace_cluster
        connect_timeout: 5.000s
        http2_protocol_options: {}
        upstream_connection_options:
          tcp_keepalive: {}
        type: STRICT_DNS
        load_assignment:
          cluster_name: tracingcluster
          endpoints:
          - lb_endpoints:
            - endpoint:
                address:
                  socket_address:
                    address: zipkin.default.svc.cluster.local
                    port_value: 9411

• curl cmd

glooctl proxy url
# returns something like: http://35.229.81.32:80
curl --header "x-client-trace-id: 123abc" --header "x-envoy-decorator-operation: optional-category-identifier" http://35.229.81.32:80/abcd

Working with Istio's Jaeger is essentially the same. Just install Istio with Jaeger, and update the tracing cluster's socket_address to refer to the zipkin service that Istio created for Jaeger, which would be this, by default:
address: zipkin.istio-system.svc.cluster.local

When I tested the Squash demo application in Visual Studio Code like described in the file squash/docs/overview/_index.md, I can't set a break point and get this error message:

SetBreakPointsRequest
All cleared
Creating on: /home/olaf/projects/squash/contrib/example/service1/main.go (/home/yuval/go/src/github.com/solo-io/squash/contrib/example/contrib/example/service1/main.go) :88
Error on CreateBreakpoint: could not find /home/yuval/go/src/github.com/solo-io/squash/contrib/example/contrib/example/service1/main.go:88
All set:[null]

If I changed the remote path in Visual Studio Code to /home/yuval/go/src/github.com/solo-io/squash/ I can set breakpoints and debug the application. Is there something special about my Visual Studio Code setup?

New UI requires that you helm ... --set gatewayProxies.gatewayProxyV2.readConfig=true for the Envoy configs to be visible in UI. Need dedicated section on install page that both

• clearly shows how to do this with helm, including need to add gloo. prefix for GlooE --set gloo.gatewayProxies.gatewayProxyV2.readConfig=true
• explains why this option is not true by default, i.e. what risks are the users assuming by enabling this option

Confusing nav pop in/out. Default alignment is off.

Need AWS EKS installation guide similar to GKE and AKE install guides.

It goes to https://github.com/solo-io/gloo repo which is not where these docs are hosted, so that's confusing. I hope you consider fixing.

Get Console doc to at least parity with glooctl guides

At https://docs.solo.io/gloo/latest/advanced_configuration/multiple-gloo-installs/#scoping-gloo-to-specific-namespaces, "watchNamespaces setting" link is broken. I guess it's a bug in the doc creation automation.

Document the workaround used here solo-io/gloo#1256, preferably with a way to avoid disabling NET_BIND_SERVICE.

We currently document the values supported by our Helm chart here. When installing the GlooE Helm chart, some of these values will not work without adding a gloo prefix to their name. This is because the OS Gloo chart is child chart to the GlooE chart.

We should fix our charts to provide a more consistent user experience. In the meantime we should document this behavior.

Gloo helm options table is auto generated from the code: https://gloo.solo.io/installation/gateway/kubernetes/#list-of-gloo-helm-chart-values

GlooEE options aren't auto generated, and easily get outdated: https://gloo.solo.io/installation/enterprise/#list-of-gloo-helm-chart-values

The Gloo enterprise start guide should be included in here. Currently the installation guides are using open source gloo and it should be clear which guides are for open source and which are for enterprise.

https://squash.solo.io/secure_mode/admin/

also link to and emphasize it from https://squash.solo.io/secure_mode/user/

how to do header based routing, e.g. https://scott.cranton.com/canary-deployments-with-solo.html

how to do weighted destination routes

We want to host docs that are versioned with the product. There are some technical limitations with our deployment and docs build tools that make this a bit tricky.

• One idea is to manage each version of Gloo docs on a branch / tag in this repo, and cut a new tag when there is a new version of the product. Then, we could push just that version's updated content to a versioned directory on the site. However, our site hosting / deployment tool, Firebase, doesn't allow for deploying a subdirectory of a site via the CLI (as of 2018 it was an open feature request). We may be able to accomplish this via the Firebase API but this will complicate our deployment process and needs to be investigated.
• Another idea is to manage each version of the docs in a separate folder in the main content directory, and then deploy the entire site from master like we do already. This means the repo would grow as new versions of the product are introduced, but it would have the benefit of not having to change our firebase steps, and we could potentially host all our docs, not just Gloo docs, in the same repo without having to worry about branch tag issues. This requires some customization of the Hugo theme so that the top-level sections (versions) are hidden from the menu, and a version drop down is added to the navigation, and each page is made version-aware so the version selector can function correctly. This is beyond my expertise.

Until we have a path forward, this repo will only contain docs for the latest version of gloo open source + enterprise.

https://gloo.solo.io/operator_guide/observability/

configrued

Currently it refers to istio

https://gloo.solo.io/gloo_integrations/cert_manager/

e.g., https://gloo.solo.io/gloo_routing/virtual_services/authentication/plugin_auth/

the hyperlinks don't render in notice blocks

when the site is served locally, the notice blocks render markdown as expected actually they also render wrong, my memory doesn't serve me correctly

my first guess is that we have a slightly different hugo version/setup deployed. markdown isn't rendered across the entire site, not just the page linked -- so fixing it will greatly improve the quality of our docs

solo-docs/gloo/docs/installation/_index.md

"open source quick start guide" link is broken

• Include in gloo docs
• Ideally link from enterprise changelog when dependency bump occurs.

Currently the NodePort doc (https://github.com/solo-io/gloo-docs/blob/master/docs/installation/node_port.md) suggests how to configure Gloo with Kubernetes using Node port in a production setting. This isn't a likely path forward for enterprises and it should be reframed.

Need a set of guides that help users understand how to set up an AWS cluster that will work well with Gloo, how to architect AWS and Gloo components, and starter demos that highlight the benefits Gloo brings to an AWS setup.

I think this was removed at some point -- please add back to all docs

To reproduce, run: https://github.com/stevenvachon/broken-link-checker

blc -ro https://gloo.solo.io

broken.txt

readers are confused about how to configure prefixRewrite, and the ask to add two (2) route/path matching entries given how envoy implements prefix_rewrite

Notice in the following image that we don't meet the AAA requirements and barely pass AA requirements.

Which is where it is causing me issues reading the documentation

It seems that in the file core-override.css the selector article section.page could be changed to #333 (always a safe bet using white backgrounds to use #333

Document a prescriptive architecture on how to use AWS LB with Gloo with and without TLS

Hello - saw that Gloo can consume a Swagger doc from the service (very cool feature). However, I cannot find what versions of Swagger are supported by Gloo, for example, is v3 supported?

https://gloo.solo.io/installation/kubernetes/quick_start/

User Guides

at bottom

make deploy-site is run when PRs are tested and there is nothing checking the version env variable to prevent the deploy from going through.

h1#upgrading-to-0-18-on-kubernetes needs "line-height: 56px"

solo-docs/gloo/docs/installation/_index.md

installation with helm link is broken

This functionality is turned off by default, and can be turned on a couple of different ways: through Helm chart install options; and through environment variables.

the Helm chart install options link is broken, https://gloo.solo.io/user_guides/setup_options/observability/

Also, some headers here are being rendered as plaintext as part of the paragraph they describe, which is confusing: https://gloo.solo.io/user_guides/setup_options/

e.g.,

Usage Statistics Gloo will periodically collect usage information

Motivation By default, microservices deployed

Motivation Gloo’s Function Discovery Service (FDS) attempt

Users are asking for this tutorial https://github.com/solo-io/gloo/tree/old-master/example/grpc

As it is linked (broken link now) through this blog post: https://medium.com/solo-io/new-in-gloo-connect-json-clients-to-your-grpc-services-4724656ed15f

here's a partial yaml spec to get started:

kubectl get vs default -n gloo-system -o yaml
apiVersion: gateway.solo.io/v1
kind: VirtualService
metadata:
  name: default
  namespace: gloo-system
spec:
  virtualHost:
    domains:
    - '*'
    name: gloo-system.default
    routes:
    - matcher:
        exact: /shelves4
        methods:
        - GET
      routeAction:
        single:
          destinationSpec:
            grpc:
              function: ListShelves
              service: grpc-bookstore
          upstream:
            name: default-grpc-bookstore-8080
            namespace: gloo-system

slack link

docs were recently refactored in #454

a number of docs appear to have been lost in the refactor.
#472 and #468 restored previously deleted user_guides for knative and kubernetes ingress.

717e9c3 was the last commit before the overhaul was merged. i've done a diff with

git diff master 717e9c3ac167164d109e0c8cfd95d5196d849651

to try to determine which other docs were lost. i've listed their filenames here but i may be missing some, or may have accidentally listed a file here which was moved/intentionally deleted:

a/gloo/docs/user_guides/concepts/declarative_infrastructure_and_gitops.md
a/gloo/docs/user_guides/concepts/gloo_declarative_model.md
a/gloo/docs/user_guides/concepts/understanding_gloo_configuration.md
a/gloo/docs/user_guides/gateway/configuring_route_options/advanced_route_plugins.md
a/gloo/docs/user_guides/gateway/configuring_route_options/append_remove_headers.md
a/gloo/docs/user_guides/gateway/configuring_route_options/advanced_routing_action.md
a/gloo/docs/user_guides/gateway/configuring_route_options/listener_plugins.md
a/gloo/docs/user_guides/gateway/configuring_route_options/listener_plugins.md
a/gloo/docs/user_guides/gateway/external_services/static_upstream.md

Http Connection Manager
Web gRPC
Tracing

See https://gloo.solo.io/api/

https://gloo.solo.io/enterprise/installation/install_glooctl/

glooctl --version
glooctl enterprise edition version 0.13.9

latest release is 0.13.15
https://github.com/solo-io/solo-projects/releases

I noticed because the redis image pull failed

Potential fixes:

• point to a "latest" release
  • Not sure if google storage supports this
• point to the github releases page
  • lose the one-click download feature
• implement a download page with redirects?
  • solo-io/build#13 (comment)

What do you think @scranton @rickducott

prevent recurrence of issues like #601