Skip to content

Commit b55a12c

Browse files
nugoncalnugoncal
authored
Merge pull request #1 from oracle-devrel/develop
First commit in DevRel
2 parents ae53086 + 1174a4d commit b55a12c

32 files changed

+2245
-47
lines changed

‎LICENSE‎

Lines changed: 201 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,201 @@
1-
Copyright (c) 2021 Oracle and/or its affiliates.
2-
3-
The Universal Permissive License (UPL), Version 1.0
4-
5-
Subject to the condition set forth below, permission is hereby granted to any
6-
person obtaining a copy of this software, associated documentation and/or data
7-
(collectively the "Software"), free of charge and under any and all copyright
8-
rights in the Software, and any and all patent rights owned or freely
9-
licensable by each licensor hereunder covering either (i) the unmodified
10-
Software as contributed to or provided by such licensor, or (ii) the Larger
11-
Works (as defined below), to deal in both
12-
13-
(a) the Software, and
14-
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
15-
one is included with the Software (each a "Larger Work" to which the Software
16-
is contributed by such licensors),
17-
18-
without restriction, including without limitation the rights to copy, create
19-
derivative works of, display, perform, and distribute the Software and make,
20-
use, sell, offer for sale, import, export, have made, and have sold the
21-
Software and the Larger Work(s), and to sublicense the foregoing rights on
22-
either these or other terms.
23-
24-
This license is subject to the following condition:
25-
The above copyright notice and either this complete permission notice or at
26-
a minimum a reference to the UPL must be included in all copies or
27-
substantial portions of the Software.
28-
29-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35-
SOFTWARE.
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018-2019 Redis Labs
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 100 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,118 @@
11
# terraform-oci-arch-redis
22

3-
[![License: UPL](https://img.shields.io/badge/license-UPL-green)](https://img.shields.io/badge/license-UPL-green) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=oracle-devrel_terraform-oci-arch-redis)](https://sonarcloud.io/dashboard?id=oracle-devrel_terraform-oci-arch-redis)
3+
Redis is an open source, in-memory data structure store that is used as a database, cache, and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, HyperLogLogs, geospatial indexes with radius queries, and streams.
44

5-
## THIS IS A NEW, BLANK REPO THAT IS NOT READY FOR USE YET. PLEASE CHECK BACK SOON!
5+
This reference architecture shows a typical six-node deployment of a Redis cluster on Oracle Cloud Infrastructure Compute instances.
66

7-
## Introduction
8-
MISSING
7+
For details of the architecture, see [_Deploy a highly available, distributed cache using Redis_](https://docs.oracle.com/en/solutions/deploy-redis-cluster/index.html)
98

10-
## Getting Started
11-
MISSING
9+
## Architecture Diagram
1210

13-
### Prerequisites
14-
MISSING
11+
![](./images/oci-redis.png)
1512

16-
## Notes/Issues
17-
MISSING
13+
## Prerequisites
1814

19-
## URLs
20-
* Nothing at this time
15+
- Permission to `manage` the following types of resources in your Oracle Cloud Infrastructure tenancy: `vcns`, `internet-gateways`, `route-tables`, `security-lists`, `subnets`, `autonomous-database-family`, and `instances`.
16+
17+
- Quota to create the following resources: 1 VCN, 1 subnets, 1 Internet Gateway, 1 NAT Gateway, 1 route rules, and 6 compute instance.
18+
19+
If you don't have the required permissions and quota, contact your tenancy administrator. See [Policy Reference](https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Reference/policyreference.htm), [Service Limits](https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/servicelimits.htm), [Compartment Quotas](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcequotas.htm).
20+
21+
## Deploy Using Oracle Resource Manager
22+
23+
1. Click [![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-devrel/terraform-oci-arch-redis/releases/latest/download/terrafomr-oci-arch-redis-stack-latest.zip)
24+
25+
26+
If you aren't already signed in, when prompted, enter the tenancy and user credentials.
27+
28+
2. Review and accept the terms and conditions.
29+
30+
3. Select the region where you want to deploy the stack.
31+
32+
4. Follow the on-screen prompts and instructions to create the stack.
33+
34+
5. After creating the stack, click **Terraform Actions**, and select **Plan**.
35+
36+
6. Wait for the job to be completed, and review the plan.
37+
38+
To make any changes, return to the Stack Details page, click **Edit Stack**, and make the required changes. Then, run the **Plan** action again.
39+
40+
7. If no further changes are necessary, return to the Stack Details page, click **Terraform Actions**, and select **Apply**.
41+
42+
## Deploy Using the Terraform CLI
43+
44+
### Clone the Module
45+
Now, you'll want a local copy of this repo. You can make that with the commands:
46+
47+
git clone https://github.com/oracle-devrel/terraform-oci-arch-redis.git
48+
cd terraform-oci-arch-redis
49+
ls
50+
51+
### Set Up and Configure Terraform
52+
53+
1. Complete the prerequisites described [here](https://github.com/cloud-partners/oci-prerequisites).
54+
55+
2. Rename `provider.tf.cli` to `provider.tf`
56+
57+
3. Create a `terraform.tfvars` file, and specify the following variables:
58+
59+
```
60+
# Authentication
61+
tenancy_ocid = "<tenancy_ocid>"
62+
user_ocid = "<user_ocid>"
63+
fingerprint = "<finger_print>"
64+
private_key_path = "<pem_private_key_path>"
65+
66+
# Region
67+
region = "<oci_region>"
68+
69+
# Compartment
70+
compartment_ocid = "<compartment_ocid>"
71+
72+
````
73+
### Create the Resources
74+
Run the following commands:
75+
76+
terraform init
77+
terraform plan
78+
terraform apply
79+
80+
### Destroy the Deployment
81+
When you no longer need the deployment, you can run this command to destroy the resources:
82+
83+
terraform destroy
84+
85+
## Deploy as a Module
86+
It's possible to utilize this repository as remote module, providing the necessary inputs:
87+
88+
```
89+
module "terraform-oci-arch-redis" {
90+
source = "github.com/oracle-devrel/terraform-oci-arch-redis"
91+
tenancy_ocid = "<tenancy_ocid>"
92+
user_ocid = "<user_ocid>"
93+
fingerprint = "<user_ocid>"
94+
region = "<oci_region>"
95+
private_key_path = "<private_key_path>"
96+
}
97+
```
2198
2299
## Contributing
23100
This project is open source. Please submit your contributions by forking this repository and submitting a pull request! Oracle appreciates any contributions that are made by the open source community.
24101
102+
### Attribution & Credits
103+
Initially, this project was created and distributed in [GitHub Oracle QuickStart space](https://github.com/oracle-quickstart/oci-redis). For that reason, we would like to thank all the involved contributors enlisted below:
104+
- Oguz Pastirmaci (https://github.com/OguzPastirmaci)
105+
- Lukasz Feldman (https://github.com/lfeldman)
106+
- Pinkesh Valdria (https://github.com/pvaldria)
107+
- Ben Lackey (https://github.com/benofben)
108+
- Claudio Di Vita (https://github.com/cdivita)
109+
- J Collin Poczatek (https://github.com/cpoczatek)
110+
- Sanjay Narvekar (https://github.com/NarvekarS)
111+
25112
## License
26113
Copyright (c) 2021 Oracle and/or its affiliates.
27114
28115
Licensed under the Universal Permissive License (UPL), Version 1.0.
29116
30117
See [LICENSE](LICENSE) for more details.
118+

0 commit comments

Comments
 (0)