sso_*: various documentation additions

[Jusshersmith]

• As described in Broken link in docs #302, we're pointing to a file that no longer exists.

• In the quickstart, UPSTREAM_CONFIGSFILEshould be UPSTREAM_CONFIGFILE (note the 'S' has been removed in 'CONFIGFILE'). Unless corrected, the quickstart results in Misdirected Request.

  sso/internal/proxy/configuration.go

  Line 369 in cb8d523

  ConfigsFile string `mapstructure:"configfile"`

• Some general touchups of documentation in docs/sso_config.md

• Creation of adocs/sso_proxy_config.md file, containing all available configuration variables for sso_proxy (the equivalent sso_auth file is here. For reference, a lot of these descriptions existed once upon a time here:

  sso/internal/proxy/options.go

  Lines 19 to 53 in d2e1ee5

  	// Options are configuration options that can be set by Environment Variables
  	// Port - int - port to listen on for HTTP clients
  	// ProviderURLString - the URL for the provider in this environment: "https://sso-auth.example.com"
  	// ProxyProviderURLString - the internal URL for the provider in this environment: "https://sso-auth-int.example.com"
  	// UpstreamConfigsFile - the path to upstream configs file
  	// Cluster - the cluster in which this is running, used for upstream configs
  	// Scheme - the default scheme, used for upstream configs
  	// SkipAuthPreflight - will skip authentication for OPTIONS requests, default false
  	// DefaultAllowedEmailDomains - csv list of emails with the specified domain to authenticate. Use * to authenticate any email
  	// DefaultAllowedEmailAddresses - []string - authenticate emails with the specified email address (may be given multiple times). Use * to authenticate any email
  	// DefaultAllowedGroups - csv list of default allowed groups that are applied to authorize access to upstreams. Will be overridden by groups specified in upstream configs.
  	// DefaultProviderSlug - the provider that upstreams should use by default. Provider must exist within `sso_auth`. ie: "google"
  	// ClientID - the OAuth Client ID: ie: "123456.apps.googleusercontent.com"
  	// ClientSecret - The OAuth Client Secret
  	// DefaultUpstreamTimeout - the default time period to wait for a response from an upstream
  	// DefaultUpstreamTCPResetDeadline - the default time period to wait for a response from an upstream
  	// TCPWriteTimeout - http server tcp write timeout - set to: max(default value specified, max(upstream timeouts))
  	// TCPReadTimeout - http server tcp read timeout
  	// CookieName - name of the cookie
  	// CookieSecret - the seed string for secure cookies (optionally base64 encoded)
  	// CookieDomain - an optional cookie domain to force cookies to (ie: .yourcompany.com)*
  	// CookieExpire - expire timeframe for cookie
  	// CookieSecure - set secure (HTTPS) cookie flag
  	// CookieHTTPOnly - set HttpOnly cookie flag
  	// PassAccessToken - send access token in the http headers
  	// Provider - OAuth provider
  	// DefaultProviderSlug - OAuth provider slug, used internally to identity a specific provider
  	// Scope - OAuth scope specification
  	// SessionLifetimeTTL - time to live for a session lifetime
  	// SessionValidTTL - time to live for a valid session
  	// GracePeriodTTL - time to reuse session data when provider unavailable
  	// RequestLoging - boolean whether or not to log requests
  	// StatsdHost - host addr for statsd client to listen on
  	// StatsdPort - port for statsdclient to listen on
  	// ShutdownTimeout - maximum time to wait for in-flight HTTP requests to complete before shutdown

[codecov]

Codecov Report

Merging #315 (8071ac0) into main (b008111) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #315   +/-   ##
=======================================
  Coverage   62.73%   62.73%           
=======================================
  Files          58       58           
  Lines        4286     4286           
=======================================
  Hits         2689     2689           
  Misses       1382     1382           
  Partials      215      215           

Impacted Files	Coverage Δ
internal/proxy/configuration.go	89.80% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b008111...8071ac0. Read the comment docs.