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.

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

Update oci.auth-strategy values in generated OCI archetype to avoid UnsatisfiedResolutionException #9073

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This example demonstrates Helidon's integration with Oracle Cloud Infrastructure
6. Logs published to OCI Logging Service
7. OCI Custom Logs Monitoring using Unified Monitoring Agent
8. Health and Liveness checks
9. Configuration profiles for switching between `config_file` and `instance_principal` configurations
9. Configuration profiles for switching between `config-file` and `instance-principals` configurations

This project demonstrates OpenApi-driven development approach where the practice of designing and building APIs is done first,
then creating the rest of an application around them is implemented next. Below are the modules that are part of this project:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,16 +203,16 @@ and currently has the following parameters:
7. `oci.logging.id` - Custom log id configured. Please see [Custom Logs Monitoring](#Custom-Logs-Monitoring) for more information.
8. `oci.auth-strategy` - Allows OCI client authentication mechanism to be specified and can either be an individual
value or a list of authentication types separated by comma. If specified as a list, it will cycle through each until a
successful authentication is reached. This is currently set to `config_file,instance_principals,resource_principal`
which means that `config_file` will be tried first, then falls back to `instance_principals` if it fails, and
eventually falls back to `resource_principals` if `instance_principals` fails. The following are the different types
successful authentication is reached. This is currently set to `config-file,instance-principals,resource-principal`
which means that `config-file` will be tried first, then falls back to `instance-principals` if it fails, and
eventually falls back to `resource-principal` if `instance-principals` fails. The following are the different types
of OCI client authentication:
* `config_file` - Uses user authentication set in ~/.oci/config
* `config-file` - Uses user authentication set in ~/.oci/config
* `config` - Sets user authentication in the helidon config, i.e. microprofile-config.properties
* `instance_principals` - Uses the compute instance as the authentication and authorization principal. Please see
* `instance-principals` - Uses the compute instance as the authentication and authorization principal. Please see
[Calling Services from an Instance](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm)
for more details.
* `resource_principal` - Very similar to instance principal auth but uses OCI resources and services as the
* `resource-principal` - Very similar to instance principal auth but uses OCI resources and services as the
authentication and authorization principal such as serverless functions. Please see
[About Using Resource Principal to Access Oracle Cloud Infrastructure Resources](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/resource-principal-about.html#GUID-7EED5198-2C92-41B6-99DD-29F4187CABF5) for more information.

Expand All @@ -236,4 +236,4 @@ to replace the configured value of `server.port` (currently set to `8080`), all
`SERVER_PORT` environment variable to the desired value:
```
SERVER_PORT=8888 java -jar target/{{artifactId}}-server.jar
```
```
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Oci Authentication method using Instance Principals
oci.auth-strategy=instance_principals
oci.auth-strategy=instance-principals
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Oci Authentication method using User Credentials in an oci config file
oci.auth-strategy=config_file
oci.auth-strategy=config-file
4 changes: 2 additions & 2 deletions archetypes/archetypes/src/main/archetype/mp/oci/oci-mp.xml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ oci.monitoring.namespace=<your monitoring namespace e.g. helidon_oci>
oci.logging.id=<your oci custom log id>

# OCI Authentication strategy
oci.auth-strategy=config_file,instance_principals,resource_principal
oci.auth-strategy=config-file,instance-principals,resource-principal
]]></value>
</list>
<list key="yaml-config-entries">
Expand Down Expand Up @@ -342,7 +342,7 @@ principal when running it in an oci compute instance.

### Run the application

1. Default with no profile will use `config_file,instance_principals,resource_principal` authentication strategy
1. Default with no profile will use `config-file,instance-principals,resource-principal` authentication strategy
```bash
java -jar server/target/{{artifactId}}.jar
```
Expand Down