Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jamowei/senv

spring cloud config client written in go for non java applications
https://github.com/jamowei/senv

configuration configuration-management golang spring-cloud

Last synced: 4 months ago
JSON representation

spring cloud config client written in go for non java applications

Host: GitHub
URL: https://github.com/jamowei/senv
Owner: jamowei
License: mit
Created: 2017-11-11T14:29:09.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2018-06-08T15:59:34.000Z (over 6 years ago)
Last Synced: 2024-10-05T10:21:50.932Z (4 months ago)
Topics: configuration, configuration-management, golang, spring-cloud
Language: Go
Size: 43 KB
Stars: 14
Watchers: 2
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Senv

[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/jamowei/senv/blob/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/jamowei/senv)](https://goreportcard.com/report/github.com/jamowei/senv)
[![Build Status](https://travis-ci.org/jamowei/senv.svg?branch=master)](https://travis-ci.org/jamowei/senv)
[![Coverage Status](https://coveralls.io/repos/github/jamowei/senv/badge.svg?branch=master)](https://coveralls.io/github/jamowei/senv?branch=master)

A fast Spring cloud-config-client written in Go.

It fetches properties from a Spring cloud-config-server
and make them available via system environment variables
For more information on spring cloud config take a look [here](https://cloud.spring.io/spring-cloud-config/).

# Install

You can get the latest binary using Go:

`> go get -u github.com/jamowei/senv/senv`

or download released binary from [here](https://github.com/jamowei/senv/releases/latest).

# Example

Your spring config server is running on http://127.0.0.1:8888/.

your *application.yml* file in config repo is:
```yaml
# general
description: Spring Config Server
user: admin
workdir: /var/work
---
# test environment
spring:
profiles:
active: dev
db:
user: ${user}
password: test123
---
# production environment
spring:
profiles:
active: prod
db:
user: ${user}
password: prod123
```

your own application file *myapp.yml* in config repo:
```yaml
file:
input: ${workdir}/input.txt
output: ${workdir}/output.txt
```

and you have a static file "conf.xml" with variables:
```xml

${db.user}
${db.password}

```

then you can start your application *myapp* like the following:
* with development settings:
```
> senv env -n myapp -p dev \n
Fetching config from server at: http://127.0.0.1:8888/myapp/dev/master
Located environment: name="myapp", profiles=[dev], label="master", version=29374923859338549, state=""
> echo "$DB_USER:$DB_PASSWORD" // prints: admin:test123
> myapp -user $DB_USER -pass $DB_PASSWORD -in $FILE_INPUT -out $FILE_OUTPUT
...
```
* with production settings:
```
> senv env -n myapp -p prod \n
Fetching config from server at: http://127.0.0.1:8888/myapp/prod/master
Located environment: name="myapp", profiles=[prod], label="master", version=29374923859338549, state=""
> echo "$DB_USER:$DB_PASSWORD" // prints: admin:prod123
> myapp -user $DB_USER -pass $DB_PASSWORD -in $FILE_INPUT -out $FILE_OUTPUT
...
```
* getting the "conf.xml":
```
> senv file -n myapp -p prod conf.xml \n
Fetching file "conf.xml" from server at: http://127.0.0.1:8888/myapp/prod/master/conf.xml
> cat conf.xml //prints:
admin
prod123

> myapp -conf conf.xml
...
```

# Help

```
> senv --help
Senv is a fast native config-client for a
spring-cloud-config-server written in Go

Usage:
senv [command]

Available Commands:
env Fetches properties and sets them as environment variables
file Receives static file(s)
help Help about any command

Flags:
-h, --help help for senv
--host string configserver host (default "127.0.0.1")
-l, --label string config-repo label to be used (default "master")
-n, --name string spring.application.name (default "application")
--port string configserver port (default "8888")
-p, --profiles strings spring.active.profiles (default [default])
--version version for senv

Use "senv [command] --help" for more information about a command.
```
# ToDo's

* https support with own ca
* customizable http header for vault and basic auth
* 100% code coverage
* ...

# Contributing

1. Fork it
2. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Make changes and add them (`git add .`)
5. Commit your changes (`git commit -m 'Add some feature'`)
6. Push to the branch (`git push origin my-new-feature`)
7. Create new pull request

# License

Senv is released under the MIT license. See [LICENSE](https://github.com/jamowei/senv/blob/master/LICENSE)