Skip to content

Commit

Permalink
add tests for authentication configs via cli, add documentation for t…
Browse files Browse the repository at this point in the history
…he same topic. (#18)

* add tests for authentication configs via cli, add documentation.

---------

Co-authored-by: Hatake Kakashi <[email protected]>
Co-authored-by: OZ <[email protected]>
  • Loading branch information
3 people committed Mar 2, 2024
1 parent 4ef0170 commit e0ccbbe
Show file tree
Hide file tree
Showing 9 changed files with 96 additions and 327 deletions.
312 changes: 0 additions & 312 deletions docs/examples.markdown

This file was deleted.

6 changes: 3 additions & 3 deletions docs/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ By providing a simple configuration via a `pom.xml`, giving the necessary identi

As a result your application can use its secrets directly from those env variables, which are existing only during it's execution, instead of storing them locally. Which is more secure :policeman:
The only thing to manage is the credentials to login into Vault, and the list of secret keys you need :massage_man:.

* * *
## Why and When to use it ?
Today, most of the software applications are communicating with other applications, using some sort of credentials for identifying themselves before establishing a secure communication,
or some encryption keys for securing the communication itself.
Expand Down Expand Up @@ -67,8 +67,8 @@ But it may also be the case that :
where lots of enterprises still provide Windows PCs without a Docker or K8s.

This plugin aims to help all those cases :santa:.


* * *
## Example use cases
Some CI tools that already working with maven, for example liquibase or sonar-scanner which both have maven plugins,
are the best suite for using the Vault Maven Plugin.
Expand All @@ -80,4 +80,4 @@ Even if you do not use maven at all, you can create a `pom.xml` just for the con
and pass the secrets to your application via some other way.
Example: another maven plugin that exports the environment variables to the execution context of your application.

We provide an example for each use cases above, [further](/vault-maven-plugin/examples.html) in this documentation.
We provide an example for each use cases above, [further](/vault-maven-plugin/examples.html) in this documentation.
Loading

0 comments on commit e0ccbbe

Please sign in to comment.