solo-io / gloo-portal-issues

Public tracker for issues related to Gloo Portal
https://docs.solo.io/gloo-portal/latest/
1 stars 3 forks source link

Docs guide for adding https to API/Environment and Portal UI #136

Closed jameshbarton closed 2 years ago

jameshbarton commented 2 years ago

Describe the requested changes Adding https support is an important basic use case for many Portal users, both at the API/Environment level and for the Portal UI itself. There is reference documentation that can be pieced together to support this task, but it should be documented in a single user guide.

Link to any relevant existing docs

  1. Reference docs for the API/Environment that address TLS config.
  2. Reference docs for Portal UI that addresses TLS config.
  3. Both of the docs above refer to this Edge SslConfig, but the links are broken from the portal docs (see #127 ):
ably77 commented 2 years ago

I ran through this exercise yesterday and pieced the bits together, this is what worked for reference:

Set TLS for portal in the Portal CR:

apiVersion: portal.gloo.solo.io/v1beta1
kind: Portal
metadata:
  name: ecommerce-portal
  namespace: default
spec:
  <omitted>
  tls:
    secretRef:
      name: <secret name>
      namespace: gloo-system

Set TLS for APIs in the Environment CR:

apiVersion: portal.gloo.solo.io/v1beta1
kind: Environment
metadata:
  name: dev
  namespace: default
spec:
  <omitted>
  gatewayConfig:
    disableRoutes: false # we actually want to expose the APIs on a Gateway (optional)
    tls:
      config:
        secretRef:
          name: <secret name>
          namespace: gloo-system
        sniDomains:
        - '<SNI domain>'
      enabled: true
artberger commented 2 years ago

Thanks for raising this issue. I have a doc PR open to add this to the certificate page here: https://github.com/solo-io/dev-portal/pull/2112/files#diff-f1c1fb1686abea0980647708ae1f0d8846f8c8e85a8eee6f5eaebc202a7b1177R12

artberger commented 2 years ago

The doc is live on main: https://docs.solo.io/gloo-portal/main/guides/portal_features/custom_ca/#use-tls-certificates