Skip to content

Surface deployment settings/status in the UI #4203

Closed

Description

@bpmct

Coder deployments are configured with deployment-wide flags or environment variables (see coder server --help). While this simplifies management, it can be difficult for new admins to see the features Coder has to offer, since they are hidden as CLI flags.

Let's add a view, only visible to admins and owners which shows various configuration options (OSS and enterprise), and whether the user has it turned on for their deployment. This can also be used as a form of a "health check."

Work has already started on this in #4138, but we can use this issue to discuss which features we should surface. We do not need to surface every CLI flag. Here are some ideas:

Deployment / Networking

Unsure if these should be separate sections

  • Is the Coder tunnel enabled? What does the tunnel do?
  • What is the Access URL
  • maybe: Is it running on Docker, Kubernetes, system service, or other
  • How many coderd replicas are running? (Enterprise)
  • Is STUN enabled? What is STUN?
    • What STUN server(s) are being used
  • What DERP servers are being used?
    • Internal vs external DERP servers
    • maybe: display dashboard<->DERP latency?
  • Is SSH enabled? (enterprise can disable it, Enterprise feature: Ability for administrators to disable SSH for groups or site-wide #4131)

Provisioning

  • How many provisioner daemons are running? What is the current queue?
  • Are external provisioners connected? What are their names? (Enterprise)
  • maybe: what common cloud(s) are provisioners authenticated against?
    • e.g. Docker, AWS, Kubernetes, GCP
    • There was a concept floating around of "tags," perhaps these can be tags under the hood

Security

  • Are secure-auth cookies enabled?
  • What SSH keygen algorithm is used?
  • maybe: Is TLS enabled? (direct vs reverse proxy on access URL)

Database status:

  • Is external DB connected or is it using the built-in postgres
    • maybe: Location of built-in postgres (often `$/home/coder/.config/coderv2/postgres)
    • Probably best not to show the external db URL
  • maybe: database latency?

Metrics / observability

  • Is audit logging enabled? (Enterprise)
  • Is Coder hooked up to Prometheus?
  • Is tracing enabled?
    • What kind of data is surfaced via tracing
  • maybe: Is verbose logging enabled?
  • Is pprof enabled?
    • What kind of data is surfaced via pprof?

Authentication

  • Is username/password auth enabled
    • Can this be disabled yet?
  • Is GitHub auth enabled?
    • Which GitHub URL (github.com or GitHub-enterprise.example.com)
    • Which GitHub organization(s) can access Coder?
    • Which GitHub teams(s) can access Coder?
  • Is OIDC enabled?

Telemetry

Activity

  1. changed the title [-]Surface deployment status in the UI[/-] [+]Surface deployment settings/status in the UI[/+] on Sep 26, 2022
  2. added this to the EE milestone on Sep 28, 2022
  3. bpmct commented on Oct 7, 2022

    @bpmct
    MemberAuthor

    Here's a slimmer version that we can add today:

    General (Deployment / Networking)

    Unsure if these should be separate sections

    • What is the Access URL?
    • Is the Coder tunnel enabled? What does the tunnel do?
    • Is STUN enabled? What is STUN?
      • What STUN server(s) are being used?
    • What DERP servers are being used?
      • Internal vs external DERP servers
    • Is external DB connected or is it using the built-in postgres
      • maybe: Location of built-in postgres (often `$/home/coder/.config/coderv2/postgres)
    • How many provisioner daemons are running?
      • maybe: What is the current queue?
    • Is telemetry enabled or disabled?

    Security

    Metrics / observability

    • Is audit logging enabled? (Enterprise)
    • Is Coder hooked up to Prometheus?
    • Is tracing enabled?
    • maybe: Is verbose logging enabled?
    • Is pprof enabled?

    Authentication

    • Is username/password auth enabled
      • This should just always be on with a tooltip saying it cannot be disabled.
    • Is GitHub auth enabled?
      • Which GitHub URL (github.com or GitHub-enterprise.example.com)
      • Which GitHub organization(s) can access Coder?
      • Which GitHub teams(s) can access Coder?
    • Is OIDC enabled?
  4. f0ssel commented on Oct 7, 2022

    @f0ssel
    Member

    I think having a admin level setting endpoint would be very convenient for the frontend to consume - not only to display to admins but also to do condition logic based on these settings as well.

  5. assigned and unassigned on Oct 7, 2022
  6. f0ssel commented on Oct 11, 2022

    @f0ssel
    Member

    Unassigning myself since the backend portion of this is complete 👍

  7. removed their assignment
    on Oct 11, 2022
  8. self-assigned this
    on Oct 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions