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.

Sign up for GitHub

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-726-update-plugin-code #761

Merged
merged 3 commits into from
Aug 9, 2023
+24 −18
Merged

ENDOC-726-update-plugin-code #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64388b2
ENDOC-726-update-plugin-code
jyunmitch Jul 26, 2023
c7acab2
ENDOC-726-update-plugin-code fix links
jyunmitch Jul 26, 2023
c108921
ENDOC-726-update-plugin-code prereq correction
jyunmitch Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions vuepress/docs/next/docs/getting-started/ent-bundle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,10 @@ The following commands are applicable to both docker-based and git-based bundles
#### Command Details
* `ent ecr get-bundle-id`: The unique identifier assigned to each bundle provides a mechanism to customize parameters and add security controls for bundle-specific resources

* `ent ecr get-plugin-code`:
* Get the unique identifier for the bundle plugin
* Docker-based bundles make use of the options `[component-name] --repo=[repository-url]`
* Git-based bundles make use of the options `--auto --repo=[repository-url]`
* `ent ecr get-plugin-code`: To retrieve the unique identifier for each microservice

* Docker-based bundles: `ent ecr get-plugin-code YOUR-ORG/YOUR-PLUGIN-NAME --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE`
* Git-based bundles: `ent ecr get-plugin-code --auto --repo=[repository-url]`

* `ent ecr install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components

Expand Down
13 changes: 8 additions & 5 deletions vuepress/docs/next/tutorials/devops/plugin-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ sidebarDepth: 2
This tutorial describes three methods to utilize configuration profiles to specify resource allocation for Entando microservices. These provide a simple way to customize microservice deployment parameters for improved efficiency.

## Prerequisites
* [A working instance of Entando](../../docs/getting-started/)
* Verify dependencies with the [Entando CLI](../../docs/getting-started/entando-cli.md#check-the-environment): `ent check-env develop`
* [Add an Entando Operator ConfigMap](../consume/entando-operator.md) if needed, then
* Enable this property under the `data` section so that the Entando Operator can manage resource settings:
```yaml
entando.k8s.operator.impose.limits: "true"
Copy link
Contributor

Choose a reason for hiding this comment

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

Why was this removed? Was this a change in 7.2?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's already there in the ConfigMap

Copy link
Contributor

@nshaw nshaw Aug 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@jyunmitch Maybe I'm missing something but I don't think it's there by default. Definitely not in the template we provide https://github.com/entando/entando-releases/blob/release/7.2/dist/ge-1-1-6/samples/entando-operator-config.yaml or in the custom resources. I think it's automatically applied by AWX when we install into PS Dev but that isn't the default config. What do you think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@nshaw, you're completely right. I assumed that our Rancher test set up would be the default one. If that's not the default one, how can I know what the customers see

Copy link
Contributor

Choose a reason for hiding this comment

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

@jyunmitch Great question. It might be worth asking PJ or Sergio if there's a document on how the PS Dev env differs from a stock install. That might already exist in notion. The alternative is to check a vanilla install on multipass or check the code, like I just did, but that's a pain.

```
* Enable this property under the `data` section so the Entando Operator can manage the resource settings:
```yaml
entando.k8s.operator.impose.limits: "true"
```

## Profile Options

Expand All @@ -35,7 +37,7 @@ You will need to [retrieve the plugin code](../../docs/getting-started/entando-c

Use the following command from the root bundle project directory, where `YOUR-ORG` is your Docker organization and `YOUR-BUNDLE` contains the microservice:
```sh
ent ecr get-plugin-code YOUR-PLUGIN --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE
ent ecr get-plugin-code YOUR-ORG/YOUR-PLUGIN-NAME --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE
```

### Method 1: Inline Profile
Expand Down Expand Up @@ -80,6 +82,7 @@ data:
data:
entando.plugins.defaultProfile: YOUR-PROFILE-NAME
```
>Note: If a resourceRequirement was specified in the plugin custom resource, that will override a profile.

## References
Please refer to the [Kubernetes documentation on Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for more details.
Expand Down
8 changes: 4 additions & 4 deletions vuepress/docs/v7.2/docs/getting-started/ent-bundle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,10 @@ The following commands are applicable to both docker-based and git-based bundles
#### Command Details
* `ent ecr get-bundle-id`: The unique identifier assigned to each bundle provides a mechanism to customize parameters and add security controls for bundle-specific resources

* `ent ecr get-plugin-code`:
* Get the unique identifier for the bundle plugin
* Docker-based bundles make use of the options `[component-name] --repo=[repository-url]`
* Git-based bundles make use of the options `--auto --repo=[repository-url]`
* `ent ecr get-plugin-code`: To retrieve the unique identifier for each microservice

* Docker-based bundles: `ent ecr get-plugin-code YOUR-ORG/YOUR-PLUGIN-NAME --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE`
* Git-based bundles: `ent ecr get-plugin-code --auto --repo=[repository-url]`

* `ent ecr install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components

Expand Down
13 changes: 8 additions & 5 deletions vuepress/docs/v7.2/tutorials/devops/plugin-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ sidebarDepth: 2
This tutorial describes three methods to utilize configuration profiles to specify resource allocation for Entando microservices. These provide a simple way to customize microservice deployment parameters for improved efficiency.

## Prerequisites
* [A working instance of Entando](../../docs/getting-started/)
* Verify dependencies with the [Entando CLI](../../docs/getting-started/entando-cli.md#check-the-environment): `ent check-env develop`
* [Add an Entando Operator ConfigMap](../consume/entando-operator.md) if needed, then
* Enable this property under the `data` section so that the Entando Operator can manage resource settings:
```yaml
entando.k8s.operator.impose.limits: "true"
```
* Enable this property under the `data` section so the Entando Operator can manage the resource settings:
```yaml
entando.k8s.operator.impose.limits: "true"
```

## Profile Options

Expand All @@ -35,7 +37,7 @@ You will need to [retrieve the plugin code](../../docs/getting-started/entando-c

Use the following command from the root bundle project directory, where `YOUR-ORG` is your Docker organization and `YOUR-BUNDLE` contains the microservice:
```sh
ent ecr get-plugin-code YOUR-PLUGIN --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE
ent ecr get-plugin-code YOUR-ORG/YOUR-PLUGIN-NAME --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE
```

### Method 1: Inline Profile
Expand Down Expand Up @@ -80,6 +82,7 @@ data:
data:
entando.plugins.defaultProfile: YOUR-PROFILE-NAME
```
>Note: If a resourceRequirement was specified in the plugin custom resource, that will override a profile.

## References
Please refer to the [Kubernetes documentation on Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for more details.
Expand Down