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

Updated the "Generate the workflows package" section in the readme related to a support ticket #391

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

Nimasha-axinom
Copy link

@Nimasha-axinom Nimasha-axinom commented Nov 21, 2024

Pull Request

Prerequisites

  • The PR is targeting the right branch (dev for features and master for
    releases)
  • potential release notes to the PR description added
  • potential testing notes to the PR description added
  • appropriate labels for the PR applied

Description

README.md Outdated
Comment on lines 205 to 209
For authentication, you need a Client ID and Client Secret of this service account.

If you have both values, the API key is just base64($clientid:$clientSecret). For
base64 you can use a tool in our Portal: https://portal.axinom.com/mosaic/tools/base64
(or any other base64 tool).
Copy link
Member

@EmperorRXF EmperorRXF Nov 21, 2024

Choose a reason for hiding this comment

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

something like this makes sense?


If you already have the plaintext Client ID & the Client Secret of the service account, you can generate the base64($clientid:$clientSecret) to be used as the api-key using a tool BASE64 generator tool, such as: https://portal.axinom.com/mosaic/tools/base64

Copy link
Author

Choose a reason for hiding this comment

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

Fixed

README.md Outdated
Comment on lines 199 to 201
Please note, that you need to provide the 'Base64 Encoded Credentials' of a
service account that has the `Pilets: Publish` permissions as `api-key`. This
[service account](https://docs.axinom.com/platform/core/identity/authenticate-serviceaccount/#what-is-a-service-account)
that has the `Pilets: Publish` permissions under the "Micro Frontend Service" as `api-key`. This
Copy link
Member

Choose a reason for hiding this comment

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

slightly change to something like this?


Please note, that you need to provide the Base64 Encoded Credentials of a
service account as the value of api-key. This service account must contain the Pilets: Publish permission of the "Micro Frontend Service" in order to be authorized to perform the action of publishing the workflows.

Copy link
Author

Choose a reason for hiding this comment

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

Fixed

README.md Outdated
value will be shown to you alongside with the other secrets when creating a
service account or when generating new secrets for an existing account.

For authentication, you need a Client ID and Client Secret of this service account.
Copy link
Member

Choose a reason for hiding this comment

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

this should either be removed, or moved further up.
As this is the general info, that the call needs the service account details - and then we can explain which permissions it needs and how to obtain it:

  1. on creation we show the calculate value
  2. if you have the plaintext values already, you can use the base64 tool, etc

Copy link
Author

Choose a reason for hiding this comment

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

Fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants