comments cleanup and readme updates

This commit is contained in:
Mozammil Khan
2024-09-24 16:28:28 +05:30
parent 227f35557a
commit 0989d4c9f5
4 changed files with 41 additions and 42 deletions

View File

@@ -74,12 +74,6 @@ const deployBAP = () => {
const vpcStack = new VpcStack(app, 'BapVpcStack', { config: config, env });
const eksStack = new EksStack(app, 'BapEksStack', {config: config, vpc: vpcStack.vpc, env });
// aws common services deployed through aws managed services
// rabbit mq -
// new DocumentDbStack(app, 'BapDocumentDbStack', { config: config, vpc: vpcStack.vpc, env });
// new RedisStack(app, 'BapRedisStack', { vpc: vpcStack.vpc, env });
// new RabbitMqStack(app, 'BapRabbitMqStack', { config: config, vpc: vpcStack.vpc, env });
// bitnami - common services on eks - self hosted
new HelmCommonServicesStack(app, 'HelmBapCommonServicesStack', {
config: config,
@@ -104,11 +98,6 @@ const deployBPP = () => {
const vpcStack = new VpcStack(app, 'BppVpcStack', {config: config, env });
const eksStack = new EksStack(app, 'BppEksStack', {config: config, vpc: vpcStack.vpc, env });
//if aws
// new DocumentDbStack(app, 'BppDocumentDbStack', { config: config, vpc: vpcStack.vpc, env });
// new RedisStack(app, 'BppRedisStack', { vpc: vpcStack.vpc, env });
// new RabbitMqStack(app, 'BppRabbitMqStack', { config: config, vpc: vpcStack.vpc, env });
// if bitnami
new HelmCommonServicesStack(app, 'HelmBapCommonServicesStack', {
config: config,
@@ -149,11 +138,6 @@ const deploySandbox = () => {
eksCluster: eksStack.cluster,
env,
});
// aws
// new DocumentDbStack(app, 'DocumentDbStack', { config: config, vpc: vpcStack.vpc, env });
// new RedisStack(app, 'RedisStack', { vpc: vpcStack.vpc, env });
// new RabbitMqStack(app, 'RabbitMqStack', { config: config, vpc: vpcStack.vpc, env });
// default - bitnami
new HelmCommonServicesStack(app, 'BapHelmCommonServicesStack', {

View File

@@ -62,6 +62,4 @@ export const getConfig = (): ConfigProps => ({
GATEWAY_EXTERNAL_DOMAIN: process.env.GATEWAY_EXTERNAL_DOMAIN || "", // user must provide it
BAP_EXTERNAL_DOMAIN: process.env.BAP_EXTERNAL_DOMAIN || "", // user must provide it
BPP_EXTERNAL_DOMAIN: process.env.BPP_EXTERNAL_DOMAIN || "", // user must provide it
});

View File

@@ -54,29 +54,6 @@ export class HelmBapStack extends Stack {
securityGroup: props.eksSecGrp,
fileSystemPolicy: myFileSystemPolicy,
});
// let efsBapFileSystemId: string | undefined;
// const existingFileSystemId = cdk.Fn.importValue('EfsBapFileSystemId');
// if(existingFileSystemId){
// efsBapFileSystemId = existingFileSystemId;
// } else{
// const efsBapFileSystem = new efs.FileSystem(this, 'Beckn-Onix-Bap', {
// vpc: props.vpc,
// securityGroup: props.eksSecGrp,
// });
// efsBapFileSystemId = efsBapFileSystem.fileSystemId;
// new cdk.CfnOutput(this, 'EfsBapFileSystemId', {
// value: efsBapFileSystemId,
// exportName: 'EfsBapFileSystemId',
// })
// }
// const efsBapFileSystemId = new efs.FileSystem(this, 'Beckn-Onix-Bap', {
// vpc: props.vpc,
// });
new helm.HelmChart(this, 'baphelm', {
cluster: eksCluster,

View File

@@ -3,6 +3,8 @@
## Overview
This guide provides instructions on how to update Helm charts and create a new release. Follow these steps to ensure your updates are applied and released correctly.
If AWS CDK is used to provision the Beckn-ONIX services, new version of Helm chart needs to be configured in AWS CDK properties as well.
## Prerequisites
- Helm installed and configured on your local machine.
- Access to the Helm chart repository and necessary permissions.
@@ -46,4 +48,42 @@ version: 1.1.0
6. Create a Pull Request to push your changes
## Creating a Release
## Creating a Release
### Packaging Helm Charts
1. Package the Helm Chart Navigate to the Helm chart directory and create a package of the chart.
```bash
helm package registry
```
This command will create a .tgz file in the current directory.
2. Move the Package to the Packages Folder Move the generated package file to a packages folder located parallel to the helm folder:
```bash
mv registry-1.1.0.tgz ../packages/
```
### Creating an Index File
1. Navigate to the `packages` directory and generate an index file that contains metadata about the packaged Helm charts.
```bash
cd ../packages
helm repo index . --url https://github.com/beckn/beckn-onix/packages
```
This command creates an `index.yaml` file in the packages directory.
### Pushing Changes to GitHub
1. Add Changes to Git Stage the newly created package and index file for commit.
```bash
git add ../packages/registry-1.1.0.tgz ../packages/index.yaml
git commit -m "Add Helm chart version 1.1.0 and update index file"
git push origin <update-branch-name>
```
2. Create a Pull Request Go to your GitHub repository and create a pull request for the changes.