Skip to content

docs: Revamp base config #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

docs: Revamp base config #41

wants to merge 14 commits into from

Conversation

ashokdevtron
Copy link
Contributor

@ashokdevtron ashokdevtron commented Feb 18, 2025

Quick Preview

  • Restructured entire Base Configurations
  • Covers Config Merge Strategy with Videos

@ashokdevtron ashokdevtron requested review from a team as code owners February 18, 2025 13:55
@ashokdevtron ashokdevtron self-assigned this Feb 18, 2025
@ashokdevtron ashokdevtron requested a review from abhibhaw March 11, 2025 13:19
Copy link
Member

@abhibhaw abhibhaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please mention that you should use the dry run post an override to see the final values.yaml or deployment template / cm / secret

Also I didn't see anything around config diff in the PR, not sure whether I missed or its covered in some other one

@@ -0,0 +1,9 @@
# Base Configurations

Base Configurations help you choose Deployment Template for defining application specifications, create ConfigMaps for managing non-sensitive data, and create Secrets for securely handling sensitive information. In Devtron, these are core settings that dictate the application's behavior.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why and when should one care about base configuration? Some of the reasons are: It's a way for sharing common configuration across env overrides, u can use it to bootstrap new pipelines/ env's... U can use scoped variables to templatize your env configuration...

@@ -0,0 +1,333 @@
# Deployment Template

In Devtron, a Deployment Template defines how your application runs by specifying its configuration settings. Devtron uses Helm charts to manage these deployments, allowing you to control everything from resource allocation to environment variables. You can use default deployment charts provided by Devtron or custom deployment charts developed by a super-admin to suit your needs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should link custom deployment chart doc here


### Using GUI

If you are not an advanced user, you may use the simpler **GUI** section to configure your chosen deployment chart.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no more basic and advance thing, it's just a GUI or yaml view.


{% hint style="warning" %}
### Who Can Perform This Action?
Superadmin can define and apply custom deployment schema.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

custom deployment gui schema?


1. In the `name` field, give a name to your schema, e.g., *schema-1*
2. Enter the `type` as JSON.
3. The `schema` field is for entering your custom deployment schema. Perform the following steps:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

custom deployment schema is not apt


## Mount Data as Data Volume

### Create ConfigMap from File
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong heading it's more like mount configmap data to a file

@@ -0,0 +1,205 @@
# Secrets

Secrets and ConfigMaps are both used to store environment variables but there is one major difference between them: ConfigMap stores key-values in normal text format; whereas secrets store them in base64 encrypted form. Devtron hides the data of secrets for the normal users and it is only visible to the users having edit permission.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not just environment variables can be as file as well, you can write like both are store data, one sensitive other non-sensitive


### Deployment Template
* Or you may copy-paste the entire config, and change the fields.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't make sense, why not use replace if u want to override everything?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants