Skip to content

Commit 4e4b53d

Browse files
committed
add secrets creation part
1 parent ecf87ed commit 4e4b53d

1 file changed

Lines changed: 120 additions & 1 deletion

File tree

docs/architecture.rst

Lines changed: 120 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,13 +540,132 @@ As a reference, below is an example of a Repository Server
540540
namespace: kanister
541541
username: <server-user>
542542
543-
RepositoryServerSecrets
543+
Repository Server Secrets
544544
=========================
545545

546546
Kanister controller needs the following secrets to be created for starting the kopia
547547
repository server successfully. The secrets are referenced in the ``RepositoryServer``
548548
CR as described in :ref:`RepositoryServer<repositoryservers>`
549549

550+
Location Secret
551+
----------------
552+
553+
# Try out filestore Location secret
554+
555+
Credentials Secret
556+
------------------
557+
558+
Following are the secret formats to be used for Azure, AWS and GCS storage credentials
559+
560+
- ``AWS S3``
561+
562+
.. code-block:: yaml
563+
:linenos:
564+
565+
apiVersion: v1
566+
kind: Secret
567+
metadata:
568+
name: s3-loc-creds
569+
namespace: <kanister-namespace>
570+
type: secrets.kanister.io/aws
571+
data:
572+
# required: base64 encoded value for key with proper permissions for the bucket
573+
access-key: <redacted>
574+
# required: base64 encoded value for the secret corresponding to the key above
575+
secret-acccess-key: <redacted>
576+
# optional: base64 encoded value for AWS IAM role
577+
role: <redacted>
578+
579+
- ``Azure``
580+
581+
.. code-block:: yaml
582+
:linenos:
583+
584+
apiVersion: v1
585+
kind: Secret
586+
metadata:
587+
name: az-loc-creds
588+
namespace: <kanister-namespace>
589+
type: secrets.kanister.io/azure
590+
data:
591+
# required: base64 encoded value for account with proper permissions for the bucket
592+
azure_storage_account_id: <redacted>
593+
# required: base64 encoded value for the key corresponding to the account above
594+
azure_storage_key: <redacted>
595+
# optional: base64 encoded value for the storage enevironment.
596+
# Acceptable values are AzureCloud, AzureChinaCloud, AzureUSGovernment, AzureGermanCloud
597+
azure_storage_environment: <redacted>
598+
599+
- ``GCS``
600+
601+
.. code-block:: yaml
602+
:linenos:
603+
604+
apiVersion: v1
605+
kind: Secret
606+
metadata:
607+
name: gcs-loc-creds
608+
namespace: <kanister-namespace>
609+
type: secrets.kanister.io/gcp
610+
data:
611+
# required: base64 encoded value for project with proper permissions for the bucket
612+
project-id: <redacted>
613+
# required: base64 encoded value for the SA with proper permissions for the bucket.
614+
# This value is base64 encoding of the service account json file when
615+
# creating a new service account
616+
service-account.json: <base64 encoded SA json file>
617+
618+
619+
Repository Password Secret
620+
--------------------------
621+
This is the password secret format used by controller to connect to kopia repository.
622+
623+
.. code-block:: yaml
624+
:linenos:
625+
apiVersion: v1
626+
kind: Secret
627+
metadata:
628+
name: repository-password
629+
namespace: <kanister-namespace>
630+
type: secrets.kanister.io/kopia-repository/password
631+
data:
632+
repo-password: <redacted>
633+
634+
Repository Server Admin User Secret
635+
-----------------------------------
636+
This is the admin credentials secret format used by the controller to start the kopia
637+
repository server
638+
639+
.. code-block:: yaml
640+
:linenos:
641+
642+
apiVersion: v1
643+
kind: Secret
644+
metadata:
645+
name: repository-server-admin
646+
namespace: <kanister-namespace>
647+
type: secrets.kanister.io/kopia-repository/serveradmin
648+
data:
649+
username: <redacted>
650+
password: <redacted>
651+
652+
653+
TLS Secret
654+
----------
655+
656+
This secret is in standard ``kubernetes.io/tls`` format
657+
658+
659+
660+
Repository Server User Access Password Secret
661+
---------------------------------------------
662+
663+
664+
665+
666+
667+
668+
550669
Controller
551670
==========
552671

0 commit comments

Comments
 (0)