Documentation

Overview

Package xds provides a transport credentials implementation where the security configuration is pushed by a management server using xDS APIs.

Experimental

Notice: All APIs in this package are EXPERIMENTAL and may be removed in a later release.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewClientCredentials

func NewClientCredentials(opts ClientOptions) (credentials.TransportCredentials, error)

    NewClientCredentials returns a new client-side transport credentials implementation which uses xDS APIs to fetch its security configuration.

    func NewServerCredentials

    func NewServerCredentials(opts ServerOptions) (credentials.TransportCredentials, error)

      NewServerCredentials returns a new server-side transport credentials implementation which uses xDS APIs to fetch its security configuration.

      Types

      type ClientOptions

      type ClientOptions struct {
      	// FallbackCreds specifies the fallback credentials to be used when either
      	// the `xds` scheme is not used in the user's dial target or when the
      	// management server does not return any security configuration. Attempts to
      	// create client credentials without fallback credentials will fail.
      	FallbackCreds credentials.TransportCredentials
      }

        ClientOptions contains parameters to configure a new client-side xDS credentials implementation.

        type ServerOptions

        type ServerOptions struct {
        	// FallbackCreds specifies the fallback credentials to be used when the
        	// management server does not return any security configuration. Attempts to
        	// create server credentials without fallback credentials will fail.
        	FallbackCreds credentials.TransportCredentials
        }

          ServerOptions contains parameters to configure a new server-side xDS credentials implementation.

          Source Files