Private deployment
Vectara Admin Center
Vectara Admin Center provides deployment-level administration for private Vectara deployments, including on-premises and VPC deployments. This guide is for platform operators who manage the deployment, rather than users administering a single tenant in the regular Vectara console.
Start with access prerequisites and sign-in instructions. If you cannot open the page or sign in, go to Troubleshoot access. Available screens and sign-in methods depend on your deployed version and configuration.
Before you begin
Obtain the following from the team responsible for your deployment:
- The deployment's console address. Use your private deployment's address, not the hosted Vectara console address.
- Network access to that address. Connect through the network access method approved for your deployment. Do not assume that a private endpoint is reachable from the public internet.
- The configured sign-in method and an authorized identity. Admin Center
requires the
platform_adminrole. Being an administrator of a tenant or account does not, by itself, grant access to Admin Center.
Limit Admin Center access to approved platform operators. If access is denied, have the responsible administrator verify your identity and authorization before changing permissions.
For account-level user administration in the regular console, see Manage Team Members.
Open Admin Center and sign in
- Connect to the network required by your deployment.
- Open
/adminon your deployment's configured console host. For example, if the console address ishttps://console.example.com, openhttps://console.example.com/admin. Replace the example hostname with your own; confirm the entry point with your deployment operator if routing has been customized. - Sign in using the authentication method configured for your deployment and your authorized identity. Do not expect every deployment to offer the same password or single sign-on options.
After successful authentication and authorization, you can access Admin Center. If the page does not open or sign-in fails, use Troubleshoot access to separate connectivity, authentication, and authorization checks.
Key functional areas
The sidebar lists the functional areas below in navigation order. Which ones appear depends on your deployed version and enabled features.
| Functional area | What you inspect | Changes you can make |
|---|---|---|
| Health | Deployment health checks and usage summaries. | None (read-only) |
| Incidents | Active and resolved incidents. | Publish incidents and updates to the deployment's status page |
| Operations | Recent diagnostic runs and their results. | Start and cancel diagnostic test runs |
| Indexing | Indexing metrics, API request and full pipeline latency, and indexing traces. | None (read-only) |
| Traces | Traces by ID, or filtered by service, customer, status, or duration. | None (read-only) |
| Tenants | Usage, users, and corpora for the selected tenant. | Change tenant limits, Rebuild a corpus, and manage user access when those controls are available |
| Managed agents (when enabled) | Vectara-maintained agents and where they are installed. | Install agents in a tenant or uninstall an existing installation. Uninstall deletes the installation's agents and tools; its corpora and documents remain unless you select their deletion. That option can delete a corpus that existed before installation. Review the confirmation. |
| LLMs | Model configurations, enabled status, and request rate settings. | Add an LLM and edit existing configurations |
| Text Encoders | Encoder details and default parameters. | None (read-only) |
| Storage | Storage-cluster status and customer storage usage. | None (read-only) |
Header and account controls
The top bar includes the following controls:
- The key icon opens the Service account dialog. Click Retrieve to fetch the Admin Center service account credentials, or Cancel to close the dialog without retrieving them. These credentials can be used for OAuth2 authentication to access platform-level APIs. After successful retrieval, the dialog shows a Security notice and the credential fields for the account's credential type. For an OAuth2 app client, those fields are Client ID, Client Secret, and OAuth Token Endpoint, each with a copy control. Click Close when finished.
- Report a bug generates a diagnostic report. See Report a bug.
To sign out, open the account button at the bottom of the sidebar and click Sign out. The same menu shows the signed-in Email and, when the session carries one, a Customer ID.
Treat retrieved credentials as secrets. The dialog's Security notice states that you should keep them secure, not share them, and not commit them to version control. Do not include them in screenshots, bug reports, or support messages.
Health
The Health view includes a Usage summary with Tenants, Queries, and Indexing requests cards. The Queries and Indexing requests cards show the last 30 days and a percentage change compared with the previous 30 days. These usage summaries are distinct from the deployment's health checks.
Open the tenant list
Click View tenants to open the tenant list. Use the tenant detail view to inspect a specific tenant rather than treating the deployment summary as a per-tenant report.
Manage tenants
Open a tenant from Tenants to inspect its details. The tenant detail view includes Usage, Corpora, and Users tabs. Verify the selected tenant before making a change.
Change tenant limits
To update limits for the selected tenant:
- Open the tenant's Usage tab.
- Click Change limits.
- Review the limits shown in the form, including Corpora and Storage (MB). Enter storage values in the unit shown by the form.
- Click Save to submit the changes, or Cancel to close the dialog without submitting them.
Changes apply to the selected tenant. Review its usage and intended limits before saving.
Manage users
The selected tenant's Users tab lists user identities, roles, and status.
When available, the user actions include Manage access and Reset password. The interface hides these actions when the signed-in session indicates external permission management. In that case, use your organization's identity-management process rather than attempting to change permissions in Admin Center.
Manage corpora
Open the selected tenant's Corpora tab to inspect its corpora. Confirm the tenant and corpus before initiating an administrative operation.
Rebuild a corpus
The rebuild control opens a Rebuild corpus confirmation dialog. Review the selected corpus and the warning before clicking Rebuild. A rebuild is an operational change, not a read-only diagnostic; completion time depends on the amount of data in the corpus.
LLMs
The LLMs view lists model configurations, their enabled status, and request rate settings. Use the View control in Params to inspect a model's parameters.
LLM actions
- To register a configuration, follow Add an LLM.
- Click Edit in a model's Actions column to open its configuration.
Add an LLM
Have the intended provider, model identifier, and required connection and authentication details ready before opening the form. Keep credentials out of screenshots and support messages.
Register the configuration
- On the LLMs page, click Add LLM to open the registration form.
- Select the LLM provider and enter Name and Model. Complete the provider-specific connection and authentication fields shown in the form.
- Review Enabled, Requests per second, and Context limit using the form's help text. If the provider requires additional parameters for the test call, enter them as JSON in Test model parameters.
- Click Add LLM at the bottom of the form to submit the configuration.
A successful submission displays Model created successfully and returns to the LLM list. If submission fails, use the displayed error to check the configuration. To leave the form without submitting it, click Cancel.
View text encoders
The Text encoders view displays encoder details, enabled status, and Default encoder params. Click View to inspect those parameters. This view does not provide add, edit, or delete controls.
Troubleshoot access
| Symptom | What to check |
|---|---|
| The page cannot be reached, or the browser reports a TLS error | Verify the deployment's console hostname, DNS resolution, approved network access, and certificate configuration with the deployment operator. Do not disable certificate validation or make a private endpoint public as a workaround. |
The host is reachable, but /admin is not found | Ask the deployment operator to verify that Admin Center is deployed and that the entry point and routing match your configuration. A missing page does not establish a permissions problem. |
| Sign-in fails or the expected sign-in option is absent | Confirm the authentication method enabled for this deployment and the identity you are using. |
| Your identity signs in, but Admin Center reports no admin access | Ask the responsible administrator to verify the identity and its platform_admin authorization. Tenant administrator permissions alone are insufficient. |
| A documented control is absent | Check the deployed version, configuration, and external permission-management settings before assuming the control should be available. |
Record the time, relevant error message, and affected page when requesting help. Do not include passwords, tokens, or other credentials.
Report a bug
Use Report a bug to generate a support report for unexpected behavior. This flow downloads a file; it does not send the report to support automatically.
- Click Report a bug.
- Set Start time and End time to cover the issue. The date/time pickers allow selections within the past five days, with the start before the end.
- In Bug description, describe the actions taken, expected and observed behavior, and relevant context. Include reproduction steps and timestamps with their time zone.
- Click Download report to generate and download
bug-report.zip. - Review the report and any screenshots or logs under your organization's data-sharing policy. Remove credentials and sensitive information before sharing, and email the approved material to support@vectara.com.
If you cannot access Admin Center or generate a report, contact support@vectara.com with the error details you can safely share and your deployment version, if known. Follow your organization's network and data-sharing controls when submitting diagnostic material.