Skip to content

Commit 4bbf04a

Browse files
committed
Adding readme.md
1 parent 1c35ad1 commit 4bbf04a

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
This module handles opinionated Feature Store AuthN/AuthZ configuration using API Gateway on Oracle Cloud Infrastructure ([OCI][oci]). This stack is designed to be used with the [OCI Resource Manager][oci_rm] to enhance Feature store experience with AuthN/AuthZ in a single step. The stack can also be used with the [OCI Terraform Provider][oci_tf_provider] to deploy using local or CloudShell Terraform cli.
2+
3+
## Deploy Using Oracle Resource Manager
4+
5+
> ___NOTE:___ If you aren't already signed in, when prompted, enter the tenancy and user credentials. Review and accept the terms and conditions.
6+
7+
1. Click to deploy the stack
8+
9+
[![Deploy to Oracle Cloud][magic_button]][magic_oke_stack]
10+
11+
1. Select the region and compartment where you want to deploy the stack.
12+
13+
1. Follow the on-screen prompts and instructions to create the stack.
14+
15+
1. After creating the stack, click Terraform Actions, and select Plan.
16+
17+
1. Wait for the job to be completed, and review the plan.
18+
19+
1. To make any changes, return to the Stack Details page, click Edit Stack, and make the required changes. Then, run the Plan action again.
20+
21+
1. If no further changes are necessary, return to the Stack Details page, click Terraform Actions, and select Apply.
22+
23+
1. After the stack application is complete attach the auto-provisioned security rules to the respective service and node subnets of the OKE cluster.
24+
25+
### Prerequisites
26+
27+
Create a terraform.tfvars file and populate with the required variables or override existing variables.
28+
29+
Note: An example [tfvars file](examples/terraform.tfvars.example) is included for reference. Using this file is the
30+
preferred way to run the stack from the CLI, because of the large number of variables to manage.
31+
32+
To use this file just copy the example [tfvars file](examples/terraform.tfvars.example) and save it in the outermost directory.
33+
Next, rename the file to __terraform.tfvars__. You can override the example values set in this file.
34+
35+
36+
### Running Terraform
37+
38+
After specifying the required variables you can run the stack using the following commands:
39+
40+
```bash
41+
terraform init
42+
```
43+
44+
```bash
45+
terraform plan
46+
```
47+
48+
```bash
49+
terraform apply
50+
```
51+
52+
```bash
53+
terraform destroy -refresh=false
54+
```
55+
56+
57+
## License
58+
59+
Copyright (c) 2021, 2024 Oracle and/or its affiliates.
60+
Released under the Universal Permissive License (UPL), Version 1.0.
61+
See [LICENSE](./LICENSE) for more details.
62+
63+
[oci]: https://cloud.oracle.com/en_US/cloud-infrastructure
64+
[oci_rm]: https://docs.cloud.oracle.com/iaas/Content/ResourceManager/Concepts/resourcemanager.htm
65+
[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
66+
[magic_oke_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://raw.githubusercontent.com/harsh97/oci-data-science-ai-samples/feature-store/feature_store/fs_apigw_terraform.zip

0 commit comments

Comments
 (0)