Skip to content
73 changes: 73 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,79 @@
"imageless-kubernetes/config"
]
},
{
"group": "FloxHub on-prem",
"pages": [
"floxhub-onprem/intro",
{
"group": "Install",
"pages": [
"floxhub-onprem/install/overview",
"floxhub-onprem/install/requirements",
"floxhub-onprem/install/methods",
"floxhub-onprem/install/flox-environment",
"floxhub-onprem/install/offline",
"floxhub-onprem/install/next-steps"
]
},
{
"group": "Reference architectures",
"pages": [
"floxhub-onprem/reference-architectures/overview",
"floxhub-onprem/reference-architectures/single-host"
]
},
{
"group": "Administer",
"pages": [
"floxhub-onprem/administration/overview",
"floxhub-onprem/administration/get-started",
"floxhub-onprem/administration/configure",
"floxhub-onprem/administration/environment-variables",
{
"group": "Monitoring",
"pages": [
"floxhub-onprem/administration/monitoring/overview",
"floxhub-onprem/administration/monitoring/health-check"
]
},
"floxhub-onprem/administration/logs",
"floxhub-onprem/administration/object-storage",
"floxhub-onprem/administration/postgresql",
"floxhub-onprem/administration/base-catalog",
{
"group": "Maintain",
"pages": [
"floxhub-onprem/administration/maintain/overview",
"floxhub-onprem/administration/maintain/backup-restore",
"floxhub-onprem/administration/maintain/restart",
"floxhub-onprem/administration/maintain/troubleshooting"
]
},
"floxhub-onprem/administration/security",
{
"group": "Users",
"pages": [
"floxhub-onprem/administration/users/overview",
"floxhub-onprem/administration/users/identity"
]
},
"floxhub-onprem/administration/factory",
"floxhub-onprem/administration/environment-upgrades"
]
},
{
"group": "Upgrade",
"pages": [
"floxhub-onprem/upgrade/overview",
"floxhub-onprem/upgrade/before-you-upgrade",
"floxhub-onprem/upgrade/instance",
"floxhub-onprem/upgrade/troubleshooting-and-rollback",
"floxhub-onprem/upgrade/maintenance-policy"
]
}
]
},
{
"group": "Concepts",
"pages": [
Expand Down
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/base-catalog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Base catalog"
description: "Populating and refreshing the package catalog."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

Initial population, periodic refresh, upstream dependencies, supported
configuration, and recovery from an interrupted update.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/configure.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Configure FloxHub"
description: "Where site configuration lives and how to apply it."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

Links to environment variables, health checks, logs, object storage, and
PostgreSQL.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/environment-upgrades.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Automatic environment upgrades"
description: "Keeping managed environments current on a schedule."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

The scheduler, its configuration and cadence, the generations it produces, and
current limitations.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/environment-variables.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Environment variables"
description: "The site configuration contract and its defaults."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

The site variables, their defaults, the overrides every deployment must set,
secret-file inputs, and how an included environment resolves configuration.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/factory.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Factory"
description: "Building and publishing packages inside your deployment."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

The build and publishing workflow, required configuration and credentials,
inspecting results, and the current execution-mode limits.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/get-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Get started administering FloxHub"
description: "The first checks after installation and the routine operator tasks."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

Verifying services, inspecting logs, monitoring the catalog, and preparing
backups.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/logs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Log system"
description: "Where each service writes its logs and how to read them."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

Log locations, access commands, the fields worth knowing, and how to correlate
a failure across services.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/maintain/backup-restore.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Back up and restore"
description: "Protecting deployment state and recovering it."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

The database and file backup and restore commands, their prerequisites,
consistency requirements, and which persistent state is not covered.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/maintain/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Maintain FloxHub"
description: "Routine and recovery procedures for a running deployment."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

Links to backup and restore, service restart, and installation
troubleshooting, and when to use each.
15 changes: 15 additions & 0 deletions floxhub-onprem/administration/maintain/restart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Restart FloxHub"
description: "Stopping and starting services safely."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

The stop, start, and restart procedure, the status to expect, and the checks
to run afterwards.
16 changes: 16 additions & 0 deletions floxhub-onprem/administration/maintain/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Troubleshoot an installation"
description: "Diagnose and recover from common failures."
---

<Info>
**This page is under construction.** FloxHub on-prem documentation is
being written section by section. This page is a placeholder so the
surrounding navigation and links are complete.
</Info>

## Planned contents

Observed failures as symptom, diagnostic command, cause, and recovery,
covering configuration, database connectivity, identity, catalog population,
and storage.
Loading
Loading