Browse Source

Fixing doc and lint issues. Adding necessary documentation

Kian 4 years ago
parent
commit
8f4f95102e

+ 3 - 0
README.md

@@ -20,6 +20,7 @@ Multiple people and organizations are joining efforts to create a single Externa
 - [Yandex Lockbox](https://external-secrets.io/provider-yandex-lockbox/)
 - [Gitlab Project Variables](https://external-secrets.io/provider-gitlab-project-variables/)
 - [Alibaba Cloud KMS](https://www.alibabacloud.com/product/kms) (Docs still missing, PRs welcomed!)
+- [Oracle Vault](https://www.oracle.com/uk/security/cloud-security/key-management/) 
 
 ## Stability and Support Level
 
@@ -41,6 +42,8 @@ Multiple people and organizations are joining efforts to create a single Externa
 | [Yandex Lockbox](https://external-secrets.io/provider-yandex-lockbox/) |   alpha   |   @AndreyZamyslov @knelasevero          |
 | [Gitlab Project Variables](https://external-secrets.io/provider-gitlab-project-variables/) |   alpha   |   @Jabray5          |
 | Alibaba Cloud KMS                                                    |   alpha   |            @ElsaChelala                   |
+| [Oracle Vault](https://www.oracle.com/uk/security/cloud-security/key-management/) | alpha  | @KianTigger
+
 
 ## Documentation
 

+ 0 - 4
deploy/crds/external-secrets.io_clustersecretstores.yaml

@@ -434,8 +434,6 @@ spec:
                                       cluster-scoped defaults to the namespace of
                                       the referent.
                                     type: string
-                                required:
-                                - name
                                 type: object
                               privatekey:
                                 description: The Access Token is used for authentication
@@ -456,8 +454,6 @@ spec:
                                       cluster-scoped defaults to the namespace of
                                       the referent.
                                     type: string
-                                required:
-                                - name
                                 type: object
                             type: object
                         required:

+ 0 - 4
deploy/crds/external-secrets.io_secretstores.yaml

@@ -434,8 +434,6 @@ spec:
                                       cluster-scoped defaults to the namespace of
                                       the referent.
                                     type: string
-                                required:
-                                - name
                                 type: object
                               privatekey:
                                 description: The Access Token is used for authentication
@@ -456,8 +454,6 @@ spec:
                                       cluster-scoped defaults to the namespace of
                                       the referent.
                                     type: string
-                                required:
-                                - name
                                 type: object
                             type: object
                         required:

+ 10 - 0
docs/snippets/oracle-credentials-secret.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: oracle-secret
+  labels: 
+    type: oracle
+type: Opaque
+stringData:
+  privateKey: "**Private key value**, use |- for multiline"
+  fingerprint: "**Fingerprint value**"

+ 16 - 0
docs/snippets/oracle-external-secret.yaml

@@ -0,0 +1,16 @@
+apiVersion: external-secrets.io/v1alpha1
+kind: ExternalSecret
+metadata:
+  name: example
+spec:
+  refreshInterval: 0.03m
+  secretStoreRef:
+    kind: SecretStore
+    name: example # Must match SecretStore on the cluster
+  target:
+    name: secret-to-be-created # Name for the secret on the cluster
+    creationPolicy: Owner
+  data:
+  - secretKey: "**Secret Name**"
+    remoteRef:
+      key: "**Secret OCID**"

+ 18 - 0
docs/snippets/oracle-secret-store.yaml

@@ -0,0 +1,18 @@
+apiVersion: external-secrets.io/v1alpha1
+kind: SecretStore
+metadata:
+  name: example
+spec:
+  provider:
+    oracle: #Needs to match value in secretstore_types.go
+      user: "**User OCID**"
+      tenancy: "**Tenancy OCID**"
+      region: "**Region**"
+      auth:
+        secretRef:
+          privatekey:
+            name: oracle-secret
+            key: privateKey #Needs to match stringData val in secret_oracle.yml
+          fingerprint:
+            name: oracle-secret
+            key: fingerprint

+ 2 - 3
e2e/suite/oracle/provider.go

@@ -20,13 +20,12 @@ import (
 
 	// nolint
 	. "github.com/onsi/gomega"
+	"github.com/oracle/oci-go-sdk/v45/common"
+	vault "github.com/oracle/oci-go-sdk/v45/vault"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	utilpointer "k8s.io/utils/pointer"
 
-	"github.com/oracle/oci-go-sdk/v45/common"
-	vault "github.com/oracle/oci-go-sdk/v45/vault"
-
 	esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
 	esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
 	"github.com/external-secrets/external-secrets/e2e/framework"

+ 2 - 0
hack/api-docs/mkdocs.yml

@@ -50,6 +50,8 @@ nav:
         - Lockbox: provider-yandex-lockbox.md
     - Gitlab:
       - Gitlab Project Variables: provider-gitlab-project-variables.md
+    - Oracle:
+      - Oracle Vault: provider-oracle-vault.md
   - References:
     - API specification: spec.md
   - Contributing: