runai-bgu config Manual

Introduction

runai-bgu config is a command-line interface (CLI) for setting the default project on the BGU HPC cluster. This command allows you to configure which project will be used by default for all subsequent runai-bgu operations, eliminating the need to specify the project flag repeatedly. This simplifies workflow management and reduces the chance of submitting workloads to the wrong project.

This manual explains how to use runai-bgu config to set your default project configuration.

Quick Start

To set your default project, use:

$ runai-bgu config my-project

Sets the specified project as your default for all future commands.

Basic Usage

Set Default Project

Configure a project as your default:

$ runai-bgu config research-team

Sets research-team as your default project for all future runai-bgu commands.

Verify Project Access

Before setting a project, check which projects are available:

$ runai-bgu projects

Lists all projects you have access to on the cluster.

Understanding Default Project

Setting a default project affects:

Command Behavior: All runai-bgu commands will use this project unless overridden with the -p flag.
Workload Submission: New workloads will be submitted to this project by default.
Resource Visibility: Commands like list and describe will show resources from this project by default.
Access Control: You must have appropriate permissions in the project to set it as default.

Common Use Cases

Initial Setup

Set your primary project after first login:

$ runai-bgu login
$ runai-bgu projects
$ runai-bgu config my-main-project

Project Switching

Change your default when working on different projects:

$ runai-bgu config data-science-project

Team Collaboration

Set your team’s shared project as default:

$ runai-bgu config shared-research

Workflow Integration

Simplified Commands

After setting a default project, you can use commands without -p:

$ runai-bgu config my-project
$ runai-bgu submit python -n my-job -c 2 -m 4Gi  # Uses my-project automatically
$ runai-bgu list  # Shows workloads from my-project

Override When Needed

You can still specify a different project for individual commands:

$ runai-bgu list -p other-project  # Temporarily use other-project

Troubleshooting Configuration

Project Not Found

If you receive an error that the project doesn’t exist:

$ runai-bgu projects  # Verify project name and access

Check the project name spelling and ensure you have access permissions.

Permission Denied

If you can’t set a project as default:

$ runai-bgu projects  # Check your access level

Ensure you have at least viewer permissions in the project.

Configuration Not Persisting

If your default project setting doesn’t persist:

Check that your runai configuration directory is writable and that you have proper permissions.

Best Practices

Choose Actively Used Projects: Set your most frequently used project as the default to minimize command complexity.
Regular Review: Periodically review and update your default project as your work focus changes.
Team Coordination: When working on shared projects, coordinate with team members about project usage.
Documentation: Keep track of which projects you use for different types of work.

Configuration Persistence

The default project setting:

Persistent Storage: Configuration is stored in your local runai configuration files.
Session Independence: The setting persists across login/logout cycles and terminal sessions.
User-Specific: Each user maintains their own default project configuration.
Override Capability: Individual commands can override the default using the -p flag.