Admin Console
The Admin Console is the graphical user interface embedded in Buckit Server for managing a running Buckit deployment. Use it to browse buckets and objects, manage identity and access, review metrics, and configure server settings.
This page provides an overview of the Admin Console and describes configuration options and instructions for logging in.
Overview
The Admin Console is embedded as part of the Buckit Server.
Supported Browsers
The Admin Console runs on a variety of current, stable release browsers.
For the best experience in the Admin Console, use the latest stable release of your preferred browser. Some browsers that are supported include:
Chrome
Edge
Safari
Firefox
Opera
This list is not exhaustive and is subject to change.
For a full list of browsers and versions for running the Admin Console, see the Browserslist website.
Tip
The Admin Console does not support Opera Mini.
Configuration
The Admin Console inherits the majority of its configuration settings from the Buckit Server. The following environment variables enable specific behavior in the Admin Console:
Environment Variable |
Description |
|---|---|
The URL for a Prometheus server configured to scrape metrics from the Buckit deployment. The Admin Console uses this server for populating the metrics dashboard. See Monitoring and Alerting using Prometheus for a tutorial on configuring Prometheus to collect metrics from Buckit. |
|
The externally resolvable hostname for the Admin Console used by the configured external identity manager for returning the authentication response. This variable is typically necessary when using a reverse proxy, load balancer, or similar system to expose the Admin Console to the public internet. Specify an externally reachable hostname that resolves to the Admin Console. |
Static vs Dynamic Port Assignment
Buckit by default selects a random port for the Admin Console on each server startup. Browser clients accessing the Buckit Server are automatically redirected to the Admin Console on its dynamically selected port. This behavior emulates the legacy web browser behavior while reducing the the risk of a port collision on systems which were running Buckit before the embedded Console update.
You can select an explicit static port by passing the
buckit server --console-address commandline option when starting
each Buckit Server in the deployment.
For example, the following command starts a distributed Buckit deployment using
a static port assignment of 9001 for the Admin Console. This deployment
would respond to S3 API operations on the default Buckit server port :9000
and browser access on the Admin Console port :9001.
buckit server https://buckit-{1...4}.example.net/mnt/drive-{1...4} \
--console-address ":9001"
Deployments behind network routing components which require static ports for routing rules may require setting a static Admin Console port. For example, load balancers, reverse proxies, or Kubernetes ingress may by default block or exhibit unexpected behavior with the the dynamic redirection behavior.
You must also ensure that the host system firewall grants access to the configured Console port.
Logging In
The Admin Console displays a login screen for unauthenticated users. The Admin Console defaults to providing a username and password prompt for a Buckit-managed user.
Documentation
The Documentation tab opens this documentation site in a separate browser window or tab.
Available Tasks
Once logged in to the Admin Console, users can perform many kinds of tasks.
Manage objects by browsing existing objects, uploading objects, or modifying bucket settings.
Review or modify identity and security with access keys, policies, and Identity Provider settings.
Monitor the health and activities with metrics and notifications.
