chambermaid 0.5.5 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bac5b5a18928996ec0eff656de94105639482b427795b54cddf825232ff83667
4
- data.tar.gz: 4382e36051f155568e2a77a84a79bdb39d55eb0f9e640941aa6d0b85c1071661
3
+ metadata.gz: 22ceec060a8f34e8d44151977ff98af6ac3602b8967aca42a333a6e57ca5b398
4
+ data.tar.gz: f190c278b648d038fdd518cf2e8801f99036e9164a627682377384a8c9107932
5
5
  SHA512:
6
- metadata.gz: e28ac0a2b70366e8f60b882ff2e6e62b5261f6d7056f0f95e4ffd2a4c15ba9431ba8ae3610cd7be6faa040207c6edf3a3a9e0ef11d99359c1f597b25250d19bd
7
- data.tar.gz: 80f638eb0c1c445c73e37dda7e9c67c08c3009d012cb28ed8e203f5063675b79cac9cd60dc01847630eaa2ddc3c7c160be0bb9a999b5bf15d373530b1312dc25
6
+ metadata.gz: 1b338e0bf90f75194e420c225168fd4aa873d398155b232a29e1dfa29aba1518bd6531ede6436417d6c5abae71c5a0565157c43a6261bb232de8f25344b16bd8
7
+ data.tar.gz: d58b7402d7ab7648218205336ea5bd1df88d3fbbfeaa8680cd11f9666febf8c7a990a32eab5cfdbf6e1e1bb0bf40b39e4f42e7d4f5fc568f32aa6881f83c8e7d
@@ -17,6 +17,8 @@ jobs:
17
17
  id: get-version-number
18
18
  with:
19
19
  dry-run: true
20
+ release-rules:
21
+ '[{ "type": "release", "scope": "major", "release": "major" }]'
20
22
  - uses: actions/setup-ruby@v1
21
23
  with:
22
24
  ruby-version: "2.6"
@@ -35,6 +37,8 @@ jobs:
35
37
  ./Gemfile.lock
36
38
  release-assets: |
37
39
  ./pkg/*.gem
40
+ release-rules:
41
+ '[{ "type": "release", "scope": "major", "release": "major" }]'
38
42
  - name: publish to rubygems
39
43
  run: |
40
44
  mkdir -p ~/.gem
@@ -1,3 +1,9 @@
1
+ ## [0.5.5](https://github.com/mileszim/chambermaid/compare/v0.5.4...v0.5.5) (2020-08-03)
2
+
3
+ ### Documentation
4
+
5
+ - add links to documentation and more info for rdoc ([3f7ec6d](https://github.com/mileszim/chambermaid/commit/3f7ec6ddb07478ceefef83403c1e5b9de447509a))
6
+
1
7
  ## [0.5.4](https://github.com/mileszim/chambermaid/compare/v0.5.3...v0.5.4) (2020-08-03)
2
8
 
3
9
  ### Bug Fixes
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- chambermaid (0.5.5)
4
+ chambermaid (1.0.0)
5
5
  aws-sdk-ssm (~> 1.85)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -48,8 +48,10 @@ Chambermaid.configure do |config|
48
48
  config.add_namespace("/my/important/namespace", overload: true)
49
49
  end
50
50
 
51
- # Load after configuration
52
- Chambermaid.load!
51
+ # If this is standalone ruby (not a Rails environment),
52
+ # call `Chambermaid.load!` after the configuration block
53
+ #
54
+ # Chambermaid.load!
53
55
  ```
54
56
 
55
57
  **Reload SSM into ENV**
@@ -81,6 +83,62 @@ Chambermaid.log_level = :warn
81
83
 
82
84
  _Note: Chambermaid.logger is set to Rails.logger automatically if including inside a rails app_
83
85
 
86
+ ### AWS Authentication
87
+
88
+ Chambermaid expects your AWS credential configuration to live inside ENV on application load.
89
+
90
+ > **Note:** `AWS_DEFAULT_REGION` or `AWS_REGION` is **required**
91
+
92
+ You can use either:
93
+ * `AWS_ACCESS_KEY_ID`
94
+ * `AWS_SECRET_ACCESS_KEY`
95
+
96
+ or STS grants:
97
+ ```bash
98
+ $ aws-vault exec my-user -- bundle exec rails server
99
+ ```
100
+ > *See [aws-vault](https://github.com/99designs/aws-vault/blob/master/USAGE.md) docs for more info*
101
+
102
+ or a metadata endpoint grant:
103
+ * Available in attached Task or EC2 instance. *See [AWS Docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint.html) for more info.*
104
+ * Through aws-vault: `aws-vault exec -s my-user`
105
+
106
+ #### IAM Permissions Required
107
+
108
+ Since this is meant to work out of the box as a complement to [chamber cli](https://github.com/segmentio/chamber), it needs similar IAM permissions.
109
+
110
+ In this case, however, we can grant read-only to the namespace(s).
111
+ ```json
112
+ {
113
+ "Version": "2012-10-17",
114
+ "Statement": [
115
+ {
116
+ "Sid": "",
117
+ "Effect": "Allow",
118
+ "Action": "ssm:DescribeParameters",
119
+ "Resource": "*"
120
+ },
121
+ {
122
+ "Sid": "",
123
+ "Effect": "Allow",
124
+ "Action": [
125
+ "ssm:GetParametersByPath",
126
+ "ssm:GetParameters",
127
+ "ssm:GetParameter",
128
+ "kms:Decrypt"
129
+ ],
130
+ "Resource": [
131
+ "arn:aws:ssm:us-east-1:1234567890:parameter/my-chamber-service",
132
+ "arn:aws:kms:us-east-1:1234567890:key/258574a1-cfce-4530-9e3c-d4b07cd04115"
133
+ ]
134
+ }
135
+ ]
136
+ }
137
+ ```
138
+ > **Note:** `Resource` array MUST include the full ARN of the key id used for chamber cli
139
+ > *(Default alias is `parameter_store_key`)*
140
+
141
+
84
142
  ## Development
85
143
 
86
144
  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -1,3 +1,3 @@
1
1
  module Chambermaid
2
- VERSION = "0.5.5"
2
+ VERSION = "1.0.0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chambermaid
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.5
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Miles Zimmerman