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

Toc tasks from #5828 #6146

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
16 changes: 8 additions & 8 deletions docs/mp/aot.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2022 Oracle and/or its affiliates.
Copyright (c) 2021, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -26,10 +26,10 @@ include::{rootdir}/includes/mp.adoc[]
== Contents

- <<Overview, Overview>>
- <<AOT Supported Modules, AOT Supported Modules>>
- <<Supported Modules, Supported Modules>>

== Overview
Helidon applications can be compiled into a native executable using GraalVM
Helidon applications can be compiled into a native executable using the GraalVM
romain-grecourt marked this conversation as resolved.
Show resolved Hide resolved
native image.

When using applications created using the CLI, or when you configure Helidon
Expand All @@ -38,14 +38,14 @@ build a native image from your application:

1. Create an environment variable `GRAALVM_HOME` pointing to your installation of
GraalVM with `native-image` installed
2. Run Maven command `mvn clean package -Pnative-image`
3. Execute the native executable created in `target` directory of your project
2. Run the Maven command `mvn clean package -Pnative-image`
3. Execute the native executable created in the `target` directory of your project

== AOT Supported Modules
== Supported Modules

Some Helidon components are not (yet) supported in native image, some have
Some Helidon components are not (yet) supported in the native image, some have
restrictions. The following table lists all Helidon features and their support
for native image.
for the native image.

.Helidon MP features in AOT
[cols="^1,^2s,<6,<6"]
Expand Down
19 changes: 12 additions & 7 deletions docs/mp/integrations/hcv.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2022 Oracle and/or its affiliates.
Copyright (c) 2021, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,7 +29,12 @@ include::{rootdir}/includes/mp.adoc[]
- <<Overview, Overview>>
- <<maven-coordinates, Maven Coordinates>>
- <<Usage, Usage>>
* <<Extensibility, Extensibility>>
- <<Examples, Examples>>
* <<Cubbyhole Secrets, Cubbyhole Secrets>>
* <<KV1 Secrets, KV1 Secrets>>
* <<KV2 Secrets, KV2 Secrets>>
* <<Transit Secrets, Transit Secrets>>
- <<Local-Testing, Local Testing>>
- <<References, References>>

Expand Down Expand Up @@ -101,8 +106,8 @@ Each of these features is implemented as a separate module, with the Vault class

The following classes can be injected into any CDI bean (if appropriate module is on the classpath):

* Kv2Secrets - Key/Value Version 2 Secrets (versioned secrets, default)
* Kv1Secrets - Key/Value Version 1 Secrets (un-versioned secrets, legacy)
* Kv2Secrets - Key/Value Version 2 secrets (versioned secrets, default)
* Kv1Secrets - Key/Value Version 1 secrets (un-versioned secrets, legacy)
* CubbyholeSecrets - Cubbyhole secrets (token bound secrets)
* DbSecrets - Database secrets (for generating temporary DB credentials)
* PkiSecrets - PKI secrets (for generating keys and X.509 certificates)
Expand Down Expand Up @@ -176,7 +181,7 @@ class TransitResource {
}
----

=== Cubbyhole secrets
=== Cubbyhole Secrets

Cubbyhole example:

Expand Down Expand Up @@ -232,7 +237,7 @@ public class CubbyholeResource {
<2> Delete the secret on a specified path.
<3> Get the secret on a specified path.

=== KV1 secrets
=== KV1 Secrets

Key/Value version 1 secrets engine operations:

Expand Down Expand Up @@ -311,7 +316,7 @@ public class Kv1Resource {
<4> Delete the secret on a specified path.
<5> Get the secret on a specified path.

=== KV2 secrets
=== KV2 Secrets

Key/Value version 2 secrets engine operations:

Expand Down Expand Up @@ -367,7 +372,7 @@ public class Kv2Resource {
<3> Get the secret on a specified path.


=== Transit secrets
=== Transit Secrets

Transit secrets engine operations:

Expand Down
2 changes: 1 addition & 1 deletion docs/mp/integrations/jedis.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2022 Oracle and/or its affiliates.
Copyright (c) 2021, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
10 changes: 6 additions & 4 deletions docs/mp/integrations/neo4j.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2022 Oracle and/or its affiliates.
Copyright (c) 2022, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -32,6 +32,8 @@ include::{rootdir}/includes/mp.adoc[]
- <<Configuration, Configuration>>
- <<Examples, Examples>>
- <<Additional Information, Additional Information>>
* <<Neo4j Metrics Propagation, Neo4j Metrics Propagation>>
* <<Neo4j Health Checks, Neo4j Health Checks>>
- <<References, References>>

== Overview
Expand All @@ -47,7 +49,7 @@ include::{rootdir}/includes/dependencies.adoc[]
<artifactId>helidon-integrations-neo4j</artifactId>
</dependency>
----
NOTE: Check <<Neo4j Metrics propagation, Neo4j Metrics propagation>> and <<Neo4j Health Checks, Neo4j Health Checks>> for additional dependencies for _Neo4j_ `Metrics` and `Health Checks` integration.
NOTE: Check <<Neo4j Metrics Propagation, Neo4j Metrics Propagation>> and <<Neo4j Health Checks, Neo4j Health Checks>> for additional dependencies for _Neo4j_ `Metrics` and `Health Checks` integration.

== Usage

Expand Down Expand Up @@ -224,7 +226,7 @@ Full example code is available in link:https://github.com/oracle/helidon/tree/ma

== Additional Information

=== Neo4j Metrics propagation
=== Neo4j Metrics Propagation

Neo4j metrics can be propagated to the user as `MicroProfile` metrics. This is implemented in a separate Maven module. Just add

Expand All @@ -249,7 +251,7 @@ By applying these two actions, Neo4j metrics will be automatically added to the

=== Neo4j Health Checks

If your application is highly dependent on Neo4j database, health and liveness checks are essential for this application to work correctly.
If your application is highly dependent on the Neo4j database, health and liveness checks are essential for this application to work correctly.

`MicroProfile` Health checks for Neo4j are implemented in a separate Maven module:

Expand Down
8 changes: 6 additions & 2 deletions docs/mp/integrations/oci.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2022 Oracle and/or its affiliates.
Copyright (c) 2021, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -30,7 +30,11 @@ include::{rootdir}/includes/mp.adoc[]
- <<Overview, Overview>>
- <<maven-coordinates, Maven Coordinates>>
- <<Usage, Usage>>
* <<Configuring the Helidon OCI SDK Extension, Configuring the Helidon OCI SDK Extension>>
* <<Accessing OCI Services, Accessing OCI Services>>
- <<Examples, Examples>>
* <<Injecting an Object Storage Client, Injecting an Object Storage Client>>
* <<Using the Object Storage Client, Using the Object Storage Client>>
- <<References, References>>

== Overview
Expand Down Expand Up @@ -128,7 +132,7 @@ public class MyClass {
The extension implements this injection point by creating an Object Storage client
object in the link:{jakarta-inject-javadoc-url}/jakarta/inject/Singleton.html[singleton scope].

=== Using the Object Storage client
=== Using the Object Storage Client

Once you have injected an ObjectStorage client you can use it as described in:

Expand Down
2 changes: 1 addition & 1 deletion docs/mp/lra.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

///////////////////////////////////////////////////////////////////////////////

= LRA
= Long Running Actions (LRA)
:description: Long Running Actions
:keywords: helidon, mp, lra
:h1Prefix: MP
Expand Down
Loading