Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@cap-js/cap-operator-plugin
Advanced tools
Changelog
Version 0.0.1 - 23-April-2024
Readme
CAP Operator Plugin provides an easy way to generate CAP Operator resources to deploy multitenant CAP Applications.
The CAP Operator plugin requires @sap/cds-dk: ">=7.8.1"
. If @sap/cds-dk is installed globally, please ensure that the installed version is greater than or equal to 7.8.1
.
To integrate the CAP Operator Plugin into your project, follow these steps:
npm add @cap-js/cap-operator-plugin -D
After installation, execute one of the following commands based on your requirements:
To add a basic chart folder, use:
cds add cap-operator
During
cds build
, the plugin will automatically inject the templates folder into the final chart.
To add a chart folder with templates included, use:
cds add cap-operator --with-templates
During
cds build
, the plugin will copy the templates folder into the final chart.
⚠️ Experimental
To add a chart folder with the values.yaml prefilled with the design-time deployment details from the mta and mta extensions, use:
cds add cap-operator --with-mta <mta-yaml-file-path> --with-mta-extensions <mta-ext-yaml-file-path>
If you have multiple mta extensions, you can pass them as a comma-separated string to merge them.
Once executed, the chart folder or chart folder with templates will be added to your project directory.
The values.yaml
requires two types of details:
As a developer, you must fill in the design-time deployment details in the values.yaml
file, which can then be pushed to your repository. The plugin will auto-populate some of these details based on the project configuration, but verifying them and manually filling in any missing information is essential. You can refer to values.schema.json
file for the structure of the values.yaml
file.
You can utilize a YAML schema validation extension such as YAML, or run the following command to validate the values.yaml
file. You can ignore the errors from runtime values as they are not filled in yet.
helm lint <chart-path>
After filling all the design-time information in values.yaml
, run cds build
. The final chart will be generated in the gen
folder within your project directory.
Now to deploy the application, you can pass the runtime values in a separate runtime-values.yaml
file and deploy the chart using the following command:
helm upgrade -i -n <namespace> <release-name> <project-path>/gen/chart -f <runtime-values.yaml-path>
As a reference, you can check out the CAP Operator helm chart in the sample incident app. And also the corresponding runtime-values.yaml file.
If you are adding the basic chart folder using the cds add cap-operator
command, do not modify the values.schema.json
file. The templates injected automatically during cds build
are tightly coupled with the structure in values.schema.json
. If schema changes are needed, use option --with-templates
to add the templates folder and adjust them accordingly.
When defining environment variables for workloads in the values.yaml
file, it's important to mirror these definitions in the runtime-values.yaml
file. This ensures consistency and avoids potential conflicts, as Helm does not merge arrays. If you're introducing new environment variables in runtime-values.yaml
for a workload, remember to include existing variables from values.yaml
to maintain coherence.
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Copyright 2024 SAP SE or an SAP affiliate company and cap-operator-plugin contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
FAQs
Add/Build Plugin for CAP Operator
The npm package @cap-js/cap-operator-plugin receives a total of 63 weekly downloads. As such, @cap-js/cap-operator-plugin popularity was classified as not popular.
We found that @cap-js/cap-operator-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.