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

ENDOC-576 7.1 check docs for needed changes wrt bundle-id, plugin-id #584

Merged
merged 6 commits into from
Oct 10, 2022

Conversation

Lyd1aCla1r3
Copy link
Contributor

No description provided.

```sh
$ ent ecr get-plugin-id --auto --repo=https://github.com/entando-samples/entando-hub-application-bundle.git
pn-cee95efc-77ff566e-entandopsdh-entando-hub-catalog-ms
ent ecr get-plugin-code
Copy link
Collaborator

Choose a reason for hiding this comment

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

I could only get this to work with ent ecr get-plugin-code [component-name] --repo=[full-repository-url docker://registry...]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch - didn't copy over the full command

resources.limits.cpu: "1000"
resources.limits.memory: "2000"
```
### Method 2: Mapped Profile
1. Create the parameter profile in the `OperatorConfigMap` of the data profile at `data/entando.profile.YOUR-PROFILE-NAME`.
1. Create the resource parameter profile in the `OperatorConfigMap` of the data profile at `data/entando.profile.YOUR-PROFILE-NAME`, e.g.:
Copy link
Collaborator

Choose a reason for hiding this comment

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

this looks strange with the e.g. here, maybe put down by the yaml example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will remove; "example" not needed

```

### Method 3: Default Profile
1. Add the profile to the `OperatorConfigMap` in the data section at `data/entando.profile.YOUR-PROFILE-NAME`.
1. Add the resource parameter profile to the `OperatorConfigMap` in the data section at `data/entando.profile.YOUR-PROFILE-NAME`, e.g.:
Copy link
Collaborator

Choose a reason for hiding this comment

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

same here, with the e.g. It just seems to be left hanging

```
Alternatively, supply the full bundle URL (including the .git suffix):
## Add Environment Variables to the Microservice
1. To determine YOUR-BUNDLE-ID, run the following command from the root project directory. Supply the full bundle URL (including the .git suffix).
```sh
ent ecr get-bundle-id https://github.com/YOUR-ACCOUNT/YOUR-PLUGIN-BUNDLE.git
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe I'm confused, should this be docker?

And it was not a good idea originally to call this a PLUGIN-Bundle, should change the name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch - copy/paste error

agree

name: YOUR-BUNDLE-ID-my-secret
key: mySecretKey

3. Insert the following `env` section into the microservice in `entando.json`, remembering to replace `YOUR-BUNDLE-ID`. By convention, environment variables are all caps and K8s resource names are hyphenated.
Copy link
Collaborator

Choose a reason for hiding this comment

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

add the or your >> the entando.json, ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not needed

Copy link
Collaborator

Choose a reason for hiding this comment

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

add something to the bag, add an apple into the recipe, insert something into the iphone, >> thinking they all need an article. Not completely sure but entando.json is like a toyota, there can be many different ones and you wouldn't say put something into toyota??

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i remember this discussion from several months ago. either works here, because 1) there is only 1 entando.json (needs no further differentiation) and 2) entando.json is a name of a thing, not the thing itself. do something to the file. do something to the entando.json file. do something to entando.json. do something to the entando.json - seems like "file" is missing there. "the entando.json" like it's the only one out there? more examples: i gave it to my teammate. i gave it to my teammate, lydia. i gave it to lydia. i gave it to my lydia?? only if we're really super close...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screen Shot 2022-10-04 at 10 15 56 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

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


2. Check for the environment variables using the command `env` or this command:
2. Confirm the environment variables are present:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Confirm that the environment...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not needed

@nshaw
Copy link
Contributor

nshaw commented Oct 2, 2022

@Lyd1aCla1r3 did you also test the profile and env variables tutorials with these changes? Just checking if we need to run that test still.

@Lyd1aCla1r3
Copy link
Contributor Author

@nshaw i did not. i got as far as working through your scratch pad instructions. i have a bunch of questions about where to go from there; some i can probably answer myself just thinking things through, but it might be better to just cut to the chase next standup. i'll see what i can piece together in the meantime

## Add Environment Variables to the Plugin Descriptor File
1. Determine YOUR-BUNDLE-ID. You can do this from your project directory using this command:
## Add Environment Variables to the Microservice
1. To determine YOUR-BUNDLE-ID, run the following command from the root project directory. Supply the full bundle URL, remembering to update the placeholders.
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor, no need to operate from "the root project directory" if you supply the URL.

@Lyd1aCla1r3 Lyd1aCla1r3 merged commit 9666403 into main Oct 10, 2022
@nshaw nshaw deleted the ENDOC-576 branch May 23, 2023 13:44
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