Skip to main content

CGC SDK introduction

Welcome to the CGC SDK! This guide will help you get up and running quickly, whether you're a developer or someone new to cloud computing. We'll walk through everything step-by-step.

SDK allow performing the most essential tasks with CGC, like managing resources, jobs, volumes, context.

Prerequisites​

  • CGC client package installed pip install cgcsdk
  • valid CGC context file (after registration within CGC instance)

Working with the SDK​

To start working: import cgc.sdk as sdk

warning

You must ensure that valid context file is created and its server is accessible, from the environment you are going to work on

Best practices​

Resource naming​

Do:

  • Use lowercase letters, numbers, and hyphens
  • Be descriptive: user-service, postgres-db, web-frontend
  • Include environment: prod-api, test-database

Don't:

  • Use spaces or special characters
  • Use generic names like app1, test
  • Make names too long (keep under 63 characters)