VMware Secrets Manager for Cloud-Native Apps
![Using Better Commits](https://img.shields.io/badge/better--commits-enabled?style=for-the-badge&logo=git&color=a6e3a1&logoColor=D9E0EE&labelColor=302D41)
| Protect your secrets, protect your sensitive data.
: Explore VMware Secrets Manager docs at https://vsecm.com/
</
<>/ keep your secretsā¦ secret
The Elevator Pitch
VMware Secrets Manager is a delightfully-secure
Kubernetes-native secrets store.
VMware Secrets Manager (VSecM) keeps your secrets secret.
With VMware Secrets Manager, you can rest assured that your sensitive data
is always secure and protected.
VMware Secrets Manager is perfect for securely storing arbitrary configuration
information at a central location and securely dispatching it to workloads.
Tell Me More
VMware Secrets Manager is a cloud-native secure store for secrets management.
It provides a minimal and intuitive API, ensuring practical security without
compromising user experience.
VMware Secrets Manager is resilient and secure by default, storing
sensitive data in memory and encrypting any data saved to disk.
Endorsed by industry experts,
VMware Secrets Manager is a ground-up re-imagination of secrets management,
leveraging SPIFFE for authentication and providing a
cloud-native way to manage secrets end-to-end.
Getting Your Hands Dirty
Before trying VMware Secrets Manager, you might want to learn about its
architecture and design goals.
Once you are ready to start, see the Quickstart guide.
Or, if you are one of those who ālearn by doingā, you might want to dig into the
implementation details later. If thatās the case, you can directly jump to the
fun part and follow the steps here to install
VMware Secrets Manager to your Kubernetes cluster.
Dive Into Example Use Cases
There are several examples demonstrating VMware Secrets Manager sample use
cases inside the ./examples/
folder.
Container Images
Pre-built container images of VMware Secrets Manager components can be found
at: https://hub.docker.com/u/vsecm.
Build VMware Secrets Manager From the Source
You can also build VMware Secrets Manager from the source.
The Roadmap
We publicly track all VMware Secrets Manager plans on this roadmap page.
You can check it out to get a glimpse of the current planned features and how
the future of VMware Secrets Manager looks like.
Status of This Software
VMware Secrets Manager is under dynamic and progressive development.
The code weāve officially signed and released maintains a
high standard of stability and dependability. However, we do encourage
it to be used in a production environment (at your own riskāsee LICENSE).
Itās important to note that, technically speaking, VMware Secrets Manager
currently holds the status of an alpha software. This means that as we
journey towards our milestone of v1.0.0
, it's possible for changes to
occurāboth major and minor. While this might mean some aspects are not backward
compatible, it's a testament to our unwavering commitment to refining and
enhancing VMware Secrets Manager.
In a nutshell, we are ceaselessly pushing the boundaries of whatās possible while
ensuring our software stays dependable and effective for production use.
š¦š¦š¦ (Docs)
Official documentation on vsecm.com.
A Note on Security
We take VMware Secrets Managerās security seriously. If you believe you have
found a vulnerability, please follow this guideline
to responsibly disclose it.
A Tour Of VMware Secrets Manager
Check out this quickstart guide for an overview of
VMware Secrets Manager.
Open Source is better together.
If you are a security enthusiast,
join VMware Secrets Managerās Slack Workspace
and let us change the world together š¤.
Links
General Links
Guides and Tutorials
Installation
Check out this quickstart guide for an overview of VMware Secrets Manager,
which also covers installation and uninstallation instructions.
You need a Kubernetes cluster and sufficient admin rights on that cluster to
install VMware Secrets Manager.
Usage
Here is a list of step-by-step tutorials covers
several usage scenarios that can show you where and how VMware Secrets Manager
could be used.
Architecture Details
Check out this VMware Secrets Manager Deep Dive article for an overview
of VMware Secrets Manager system design and how each component fits together.
Folder Structure
VSecM == āVMware Secrets Manager for Cloud-Native Appsā
Here are the important folders and files in this repository:
./app
: Contains core VSecM componentsā source code.
./app/init-container
: Contains the source code for the VSecM Init Container.
./app/safe
: Contains the VSecM Safe source code.
./app/sentinel
: Contains the source code for the VSecM Sentinel.
./app/sidecar
: Contains the source code for the VSecM Sidecar.
./helm-charts
: Contains VSecM helm charts.
./core
: Contains core modules shared across VSecM components.
./examples
: Contains the source code of example use cases.
./hack
: Contains scripts for building, publishing, development
, and testing.
./k8s
: Contains Kubernetes manifests that are used to deploy VSecM and
its use cases.
./sdk
: Contains the source code of the VSecM Developer SDK.
./docs
: Contains the source code of the VSecM Documentation website (https://vsecm.com).
./CODE_OF_CONDUCT.md
: Contains VSecM Code of Conduct.
./CONTRIBUTING_DCO.md
: Contains VSecM Contributing Guidelines.
./SECURITY.md
: Contains VSecM Security Policy.
./LICENSE
: Contains VSecM License.
./Makefile
: The Makefile
used for building,
publishing, deploying, and testing the project.
Changelog
You can find the changelog and migration/upgrade instructions (if any)
on VMware Secrets Managerās Changelog Page.
Whatās Coming Up Next?
You can see the projectās progress in this VMware Secrets Manager roadmap.
Code Of Conduct
Be a nice citizen.
Contributing
To contribute to VMware Secrets Manager,
follow the contributing guidelines to get started.
Use GitHub issues to request features or file bugs.
Communications
Maintainers
Check out the Maintainers Page for a list
of maintainers of VMware Secrets Manager.
Please send your feedback, suggestions, recommendations, and comments to
feedback@vsecm.com.
Weād love to have them.
License
BSD 2-Clause License.