Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release 1.3.3 #82

Merged
merged 1 commit into from
Sep 13, 2023
Merged

release 1.3.3 #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/classes/AWS.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/ChainableTemporaryCredentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/CredentialProviderChain.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/Credentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/EC2MetadataCredentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/EnvironmentCredentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/RemoteCredentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/SharedFileCredentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/TokenFileWebIdentityCredentials.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h2>Topics</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.aws.config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.aws.service.rds.signer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.aws.utils.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
28 changes: 20 additions & 8 deletions docs/topics/README.md.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,17 +130,22 @@ <h3>TLS and certificate failures</h3>
<h3>Global settings</h3>

<p>This library depends on global settings. Especially the core services for authentication
and metadata. Many of those can (also) be specified as environment variables.</p>
and metadata. Many of those can (also) be specified as environment variables. Environment
variables can only be accessed during the OpenResty <code>init</code> phase. Thus, to ensure correct
configuration from environment variables, the <a href="../modules/resty.aws.config.html#">resty.aws.config</a> module must be required on
the top-level of the module using this library:</p>

<p>Hence it is recommended to populate the global configuration object at application start
in the OpenResty <code>init</code> phase. Simply add the following line;</p>

<pre><code> local _ = require("resty.aws.config").global
</code></pre>
<pre>
<span class="keyword">local</span> aws_config = <span class="global">require</span>(<span class="string">"resty.aws.config"</span>)
</pre>


<p>This ensures the environment variables can still be read (in the <code>init</code> phase). And
the auto-detection of the AWS region will execute.</p>
<p>The <code>.global</code> property of the <code>aws_config</code> variable can then be used as the global
configuration. Note that when <code>.global</code> is first accessed, automatic region detection
through the AWS metadata service is performed. Thus, it is not advisable to access
it on the module level unless to avoid startup delays in non-AWS environment, caused by
the requests to the metadata service timing out.</p>

<hr/>

Expand Down Expand Up @@ -274,6 +279,13 @@ <h2>History</h2>
<li>test installing the rock from LuaRocks</li>
</ol>

<h3>1.3.3 (13-Sep-2023)</h3>

<ul>
<li>fix: don't invoke region detection code on the module toplevel and advise against trying to.
<a href="https://github.com/Kong/lua-resty-aws/pull/81">81</a></li>
</ul>

<h3>1.3.2 (13-Sep-2023)</h3>

<ul>
Expand Down Expand Up @@ -486,7 +498,7 @@ <h3>0.1 (03-Feb-2021) Initial released version</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-13 03:26:04 </i>
<i style="float:right;">Last updated 2023-09-13 09:23:08 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
Loading