portal.proto

Package : devportal.solo.io

Top

portal.proto

Table of Contents

CustomStyling

Custom Styling options for a portal

Field Type Label Description
primaryColor string
secondaryColor string
backgroundColor string
navigationLinksColorOverride string
buttonColorOverride string
defaultTextColor string
cssStylesheet common.devportal.solo.io.DataSource Custom CSS stylesheet that will be applied to the portal. Custom stylesheets take precedence over the other styling attributes in this object.

PageSpec

Field Type Label Description
name string The name of the page.
description string Description of the page.
path string The path for this page relative to the portal base URL.
navigationLinkName string The name of the link displayed on the portal navigation bar.
displayOnHomepage bool Set to true if you want to display a tile that links to the static page on the portal home page. Only one of the static pages for a portal can set this flag to true.
content common.devportal.solo.io.DataSource Content for the page, markdown in the case of Static pages, url inline_string in the case of Dynamic

PortalSpec

A PortalSpec tells the Dev Portal Operator to fetch and serve static assets which are used by the Dev Portal UI. Each portal can publish one or more API Products.

Field Type Label Description
displayName string Display name of the portal.
description string Description for the portal.
domains []string repeated The domains on which this Portal will be served. The Host header received by the Portal Web App will be matched to one of these domains in order to determine which Portal will be served.
To prevent undefined behavior, creating a Portal whose domain conflicts with an existing Portal will result in the Portal resource being placed into an ‘Invalid’ state.
primaryLogo common.devportal.solo.io.DataSource Logo to display on the portal.
favicon common.devportal.solo.io.DataSource Browser favicon for the portal.
banner common.devportal.solo.io.DataSource The banner image for the portal.
customStyling CustomStyling Custom Styling overrides.
staticPages []PageSpec repeated Static markdown content pages for the portal.
dynamicPages []PageSpec repeated
publishApiProducts common.devportal.solo.io.Selector Select APIProducts matching these labels for publishing on the Portal. APIProducts are always selected from the Portal’s own namespace.
The set of APIProducts a specific user sees upon login will be filtered by the permissions associated either with that user’s AccessLevel, or with the AccessLevels of the groups that the user is a member of.
If the User’s accessible APIProducts and Portal APIProducts do not intersect, the user will see no APIProducts.
enableIngress google.protobuf.BoolValue Generate an Ingress route from this Portal’s domains to the web application serving this portal. Defaults to true.
oidcAuth PortalSpec.OidcAuth Use oidcAuth to allow authenticating users to the Portal using an OIDC Identity Provider. Groups will be granted access to this portal whose OIDC claims match the tokens provided by the OIDC Provider.
sslConfig gloo.solo.io.SslConfig A reference to an https cert for TLS portal requests and SNI in the Gloo Dev Portal currently only the secret_ref type is supported. Performs no function if configured in Istio Dev Portal.

PortalSpec.OidcAuth

Configuration parameters for authenticating to a Portal using OIDC. Acts as an alternative to the Dev Poratl’s built-in User management

Field Type Label Description
issuer string The issuer is the URL identifier for the service. For example: “https://accounts.google.com"
clientId string The Client ID used to register with the OIDC provider.
clientSecret common.devportal.solo.io.SecretRef Reference to a Kubernetes secret containing the OIDC Client Secret to be used to register with the OIDC authentication server. The default key used to look up the secret will be "client_secret" if not specified in the secret ref.
groupClaimKey string The Key of the OIDC claim containing the names of the Groups which are authorized to access this portal. The OIDC Server must return a space-separated list of Group names, which contain one the oidc_group_name of one or more OIDC Groups.
callbackUrlPrefix string The Callback URL is the URL on the Portal Web App to which users will be redirected after authenticating.
The callback URL must match the URL used by users to reach the portal. This should be in the format <http

PortalStatus

The current status of the Portal. The Portal will be processed as soon as it is created in the cluster.

Field Type Label Description
observedGeneration int64 The observed generation of the Portal. When this matches the Portal’s metadata.generation, it indicates the status is up-to-date.
state common.devportal.solo.io.State The current state of the portal.
reason string A human-readable string explaining the error, if any.
publishUrl string The published URL at which the portal can be accessed
apiProducts []common.devportal.solo.io.ObjectRef repeated The APIProducts that are currently considered to be part of this Portal.