Skip to content

Describe AWS Secrets Storage backend#113

Merged
pkosiec merged 3 commits intocapactio:mainfrom
pkosiec:storage-backends
Mar 14, 2022
Merged

Describe AWS Secrets Storage backend#113
pkosiec merged 3 commits intocapactio:mainfrom
pkosiec:storage-backends

Conversation

@pkosiec
Copy link
Copy Markdown
Collaborator

@pkosiec pkosiec commented Mar 11, 2022

Description

Changes proposed in this pull request:

  • Describe AWS Secrets Storage backend
  • Add very short introduction storage backends

Testing

WARNING: Make sure you installed use manifests from capactio/hub-manifests#61

You don't need to install Mattermost:

  1. Create and run Action to test the new default storage:

    1. Create TypeInstances:

      cat > /tmp/download-ti.yaml << ENDOFFILE
      typeInstances:
      - alias: "download"
        typeRef:
          path: cap.type.capactio.capact.validation.download
          revision: 0.1.0
        value:
          key: "true"
      ENDOFFILE
      export DOWNLOAD_TI=$(capact ti create -f /tmp/download-ti.yaml -ojson | jq -r '.[] | select(.alias == "download") | .id')
      cat > /tmp/update-ti.yaml << ENDOFFILE
      typeInstances:
      - alias: "update"
        typeRef:
          path: cap.type.capactio.capact.validation.update
          revision: 0.1.0
        value:
          key: "true"
      ENDOFFILE
      export UPDATE_TI=$(capact ti create -f /tmp/update-ti.yaml -ojson | jq -r '.[] | select(.alias == "update") | .id')
    2. Create Action input:

      cat > /tmp/act-input-ti.yaml << ENDOFFILE
      typeInstances:
        - name: "testUpdate"
          id: ${UPDATE_TI}
        - name: "testInput"
          id: ${DOWNLOAD_TI}
      ENDOFFILE
    3. Run Action

      capact act create cap.interface.capactio.capact.validation.action.passing --name test --type-instances-from-file /tmp/act-input-ti.yaml
    4. Run capact act run test and capact act watch test

    5. Get Action output TypeInstances:

      capact act get test -ojson | jq '.Actions[0].output.typeInstances'

      Observe the Backend ID near the cap.type.capactio.capact.validation.upload TypeInstance.

    6. Use capact ti get {id} -oyaml to see the details.

      SAMPLE_TI_ID=$(capact act get test -ojson | jq '.Actions[0].output.typeInstances | map(select(.typeRef.path == "cap.type.capactio.capact.validation.upload"))[0].id' -r)
      capact ti get $SAMPLE_TI_ID -oyaml
    7. See the AWS Secrets Manager UI to double confirm the TypeInstance value has been stored externally.

    8. Clean up the secret from AWS UI (as the delete functionality is not implemented yet).

Related issue(s)

Resolves capactio/capact#647

@pkosiec pkosiec added enhancement New feature or request WIP Work in progress area/documentation Relates to all activities around documentation area/hub Relates to Hub labels Mar 11, 2022
@pkosiec pkosiec marked this pull request as ready for review March 11, 2022 12:27
@pkosiec pkosiec removed the WIP Work in progress label Mar 11, 2022
Comment thread docs/feature/storage-backends/aws-secrets-manager.md Outdated
Comment thread docs/feature/storage-backends/aws-secrets-manager.md Outdated
Comment thread docs/feature/storage-backends/aws-secrets-manager.md Outdated
Comment thread docs/feature/storage-backends/introduction.md Outdated
Copy link
Copy Markdown
Collaborator

@mkuziemko mkuziemko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pkosiec pkosiec merged commit eb8082a into capactio:main Mar 14, 2022
@pkosiec pkosiec deleted the storage-backends branch March 14, 2022 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Relates to all activities around documentation area/hub Relates to Hub enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configure Secret storage backend to be used with Local Hub

2 participants