Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 5130413

Browse files
meker12hguthrie
andauthored
Replaced duplicate v2.3 file with symlink and cleaned services topics (#5542)
- Replaced duplicate v2.3 file with symlink and cleaned services topics - Updated the Enable RabbitMQ service instructions to match the other service-enablement procedures and added missing step to verify service relationships - Cleaned the Set up Elastic search topic to place admonitions more strategically and link to the service-versions topic. - Removed specific version from enable service procedures to simplify topic maintenance - Fixed ul and ol spacing to pass lint checks - Fixed syntax in ELASTICSUITE_CONFIGURATION yaml configuration example Co-Authored-By: hguthrie <hguthrie@users.noreply.github.com>
1 parent 9880fd8 commit 5130413

8 files changed

+213
-297
lines changed

guides/v2.2/cloud/env/variables-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ stage:
227227
indices_settings:
228228
number_of_shards: 3
229229
number_of_replicas: 3
230-
_merge: true
230+
_merge: true
231231
```
232232

233233
**Known limitations**—

guides/v2.2/cloud/project/project-conf-files_services-elastic.md

Lines changed: 35 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -14,87 +14,67 @@ functional_areas:
1414
- Supports stop words and synonyms
1515
- Indexing does not impact customers until the reindex operation completes
1616

17-
{{site.data.var.ee}} supports [Elasticsearch]({{ site.baseurl }}/guides/v2.2/config-guide/elasticsearch/es-overview.html) versions 1.4, 1.7, 2.4, and 5.2 (requires {{site.data.var.ee}} v2.2.3 or later). The recommended version is 5.2.
17+
{% include cloud/service-config-integration-starter.md %}
18+
19+
{: .bs-callout-warning}
20+
Staging and Production environments that are in the same cluster share a single Elasticsearch instance, so you must specify a unique Elasticsearch prefix for each of these environments.
1821

1922
{:.procedure}
2023
To enable Elasticsearch:
2124

22-
1. Add the `elasticsearch` service to the `.magento/services.yaml` file with the Elasticsearch version and allocated disk space in MB.
25+
1. Add the `elasticsearch` service to the `.magento/services.yaml` file with the Elasticsearch version and allocated disk space in MB.
2326

24-
```yaml
25-
elasticsearch:
26-
type: elasticsearch:5.2
27-
disk: 1024
28-
```
27+
```yaml
28+
elasticsearch:
29+
type: elasticsearch:<version>
30+
disk: 1024
31+
```
2932

30-
1. Set the `relationships` property in the `.magento.app.yaml` file.
33+
1. Set the `relationships` property in the `.magento.app.yaml` file.
3134

32-
```yaml
33-
relationships:
34-
elasticsearch: "elasticsearch:elasticsearch"
35-
```
35+
```yaml
36+
relationships:
37+
elasticsearch: "elasticsearch:elasticsearch"
38+
```
3639

37-
1. Add, commit, and push code changes.
40+
1. Add, commit, and push code changes.
3841

39-
```bash
40-
git add -A && git commit -m "Enable Elasticsearch" && git push origin <branch-name>
41-
```
42+
```bash
43+
git add -A && git commit -m "Enable Elasticsearch" && git push origin <branch-name>
44+
```
4245

43-
For information on how these changes affect your environments, see [Services]({{ page.baseurl }}/cloud/project/project-conf-files_services.html).
46+
For information on how these changes affect your environments, see [Services]({{ page.baseurl }}/cloud/project/project-conf-files_services.html).
4447

45-
1. [Verify the relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships) and configure Elasticsearch in the Admin UI.
48+
1. [Verify the service relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships) and configure Elasticsearch in the Admin UI.
4649

4750
1. Reindex the Catalog Search index.
4851

49-
```bash
50-
bin/magento indexer:reindex catalogsearch_fulltext
51-
```
52+
```bash
53+
bin/magento indexer:reindex catalogsearch_fulltext
54+
```
5255

5356
1. Clean the cache.
5457

55-
```bash
56-
bin/magento cache:clean
57-
```
58+
```bash
59+
bin/magento cache:clean
60+
```
61+
62+
## Restart the Elasticsearch service
63+
64+
If you need to restart the [Elasticsearch](https://www.elastic.co) service, you must contact Magento support.
5865

59-
## Add Elasticsearch plugins
66+
## Elasticsearch plugins
6067

61-
Optionally, you can add plugins with the `.magento/services.yaml` file. For example, to enable the ICU analysis plugin and Python script support plugin, add the `configuration:plugins` section with the listed plugin codes:
68+
Optionally, you can add Elasticsearch plugins by adding the `configuration:plugins` section to the `.magento/services.yaml` file. For example, the following code enables the ICU analysis plugin and Python script support plugins.
6269

6370
```yaml
6471
elasticsearch:
65-
type: elasticsearch:5.2
72+
type: elasticsearch:<service-version>
6673
disk: 1024
6774
configuration:
6875
plugins:
6976
- analysis-icu
7077
- lang-python
7178
```
7279

73-
The following are supported Elasticsearch plugins for version 2.4:
74-
75-
- `analysis-icu`: ICU Analysis Plugin, Support ICU Unicode text analysis
76-
- `analysis-kuromoji`: Japanese (kuromoji) Analysis Plugin, Japanese language support
77-
- `analysis-phonetic`: Phonetic Analysis Plugin, Phonetic analysis
78-
- `analysis-smartcn`: Smart Chinese Analysis Plugins
79-
- `analysis-stempel`: Stempel Polish Analysis Plugin
80-
- `cloud-aws`: AWS Cloud Plugin, allows storing indices on AWS S3
81-
- `cloud-azure`: Azure Cloud Plugin
82-
- `cloud-gce`: GCE Cloud Plugin
83-
- `delete-by-query`: Support for deleting documents matching a given query
84-
- `discovery-multicast`: Ability to form a cluster using TCP/IP multicast messages
85-
- `lang-javascript`: JavaScript language plugin, allows the use of JavaScript in Elasticsearch scripts
86-
- `lang-python`: Python language plugin, allows the use of Python in Elasticsearch scripts
87-
- `mapper-attachments`: Mapper attachments plugin for indexing common file types
88-
- `mapper-murmur3`: Murmur3 mapper plugin for computing hashes at index-time
89-
- `mapper-size`: Size mapper plugin, enables the `_size` meta field
90-
91-
See [Elasticsearch plugin documentation](https://www.elastic.co/guide/en/elasticsearch/plugins/2.4/index.html).
92-
93-
{:.bs-callout-info}
94-
If you use the ElasticSuite third-party plugin, you must [update the `{{site.data.var.ct}}` package]({{page.baseurl}}/cloud/project/ece-tools-update.html) to version 2002.0.19 or later.
95-
96-
{: .bs-callout-info }
97-
If you need to restart the [Elasticsearch](https://www.elastic.co) service, you must contact Magento support.
98-
99-
{: .bs-callout-warning}
100-
Staging and Production environments that are in the same cluster share a single Elasticsearch instance, so you must specify a unique Elasticsearch prefix for each of these environments.
80+
If you use the ElasticSuite third-party plugin, you must [update the `{{site.data.var.ct}}` package]({{page.baseurl}}/cloud/project/ece-tools-update.html) to version 2002.0.19 or later.

guides/v2.2/cloud/project/project-conf-files_services-mysql.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,26 @@ Accessing the MariaDB database directly requires you to use a SSH to log in to t
2828

2929
1. Add the required name, type, and disk value (in MB) to the `.magento/services.yaml` file.
3030

31-
```yaml
32-
mysql:
33-
type: mysql:10.2
34-
disk: 2048
35-
```
31+
```yaml
32+
mysql:
33+
type: mysql:<version>
34+
disk: 2048
35+
```
3636

3737
1. Configure the relationships in the `.magento.app.yaml` file.
3838

39-
```yaml
40-
relationships:
41-
database: "mysql:mysql"
42-
```
39+
```yaml
40+
relationships:
41+
database: "mysql:mysql"
42+
```
4343

4444
1. Add, commit, and push your code changes.
4545

46-
```bash
47-
git add -A && git commit -m "Enable mysql service" && git push origin <branch-name>
48-
```
46+
```bash
47+
git add -A && git commit -m "Enable mysql service" && git push origin <branch-name>
48+
```
4949

50-
1. [Verify the relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships).
50+
1. [Verify the service relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships).
5151

5252
{: .bs-callout-tip }
5353
MySQL errors such as `PDO Exception: MySQL server has gone away` may be a result of exhausting existing disk space. Verify that you have allocated sufficient disk space to the service in the [`.magento/services.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_magento-app.html#disk) file.

guides/v2.2/cloud/project/project-conf-files_services-rabbit.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,38 @@ The [Message Queue Framework (MQF)]({{ page.baseurl }}/config-guide/mq/rabbitmq-
1010

1111
The MQF uses [RabbitMQ](http://www.rabbitmq.com) as the messaging broker, which provides a scalable platform for sending and receiving messages. It also includes a mechanism for storing undelivered messages. RabbitMQ is based on the Advanced Message Queuing Protocol (AMQP) 0.9.1 specification.
1212

13-
We support RabbitMQ version 3.5.
14-
1513
{:.bs-callout .bs-callout-warning}
1614
If you prefer using an existing AMQP-based service, like RabbitMQ, instead of relying on {{site.data.var.ece}} to create it for you, use the [`QUEUE_CONFIGURATION`]({{ page.baseurl }}/cloud/env/variables-deploy.html#queue_configuration) environment variable to connect it to your site.
1715

1816
{% include cloud/service-config-integration-starter.md %}
1917

20-
## Add RabbitMQ in services.yaml and .magento.app.yaml {#settings}
18+
{:.procedure}
19+
To enable RabbitMQ:
2120

22-
To enable RabbitMQ, add the following code with your installed version and allocated disk space in MB to the `.magento/services.yaml` file.
21+
1. Add the required name, type, and disk value (in MB) to the `.magento/services.yaml` file along with the the installed RabbitMQ version.
2322

24-
```yaml
25-
rabbitmq:
26-
type: rabbitmq:<version>
27-
disk: 1024
28-
```
23+
```yaml
24+
rabbitmq:
25+
type: rabbitmq:<version>
26+
disk: 1024
27+
```
2928

30-
To configure the relationships for the environment variable, set a relationship in your `.magento.app.yaml` file. For example:
29+
1. Configure the relationships in the `.magento.app.yaml` file.
3130

32-
```yaml
33-
relationships:
34-
rabbitmq: "rabbitmq:rabbitmq"
35-
```
31+
```yaml
32+
relationships:
33+
rabbitmq: "rabbitmq:rabbitmq"
34+
```
35+
36+
1. Add, commit, and push your code changes.
3637

37-
Merge and deploy the code to set the configurations for RabbitMQ. For information on how these changes affect your environments, see [`services.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_services.html).
38+
```bash
39+
git add -A && git commit -m "Enable RabbitMQ service" && git push origin <branch-name>
40+
```
41+
42+
1. [Verify the service relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships).
43+
44+
For information on how these changes affect your environments, see [`services.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_services.html).
3845

3946
## Connect to RabbitMQ for debugging {#connect}
4047

@@ -46,17 +53,17 @@ For debugging purposes, it is useful to directly connect to a service instance i
4653

4754
### Connect from your local development environment {#cloud-rabbitmq-conn-loc}
4855

49-
1. Log in to the Magento Cloud CLI and project:
56+
1. Log in to the Magento Cloud CLI and project:
5057

51-
```bash
52-
magento-cloud login
53-
```
58+
```bash
59+
magento-cloud login
60+
```
5461

55-
1. Checkout the environment with RabbitMQ installed and configured.
62+
1. Checkout the environment with RabbitMQ installed and configured.
5663

57-
```bash
58-
magento-cloud environment:checkout <environment-id>
59-
```
64+
```bash
65+
magento-cloud environment:checkout <environment-id>
66+
```
6067

6168
1. Use SSH to connect to the Cloud environment:
6269

guides/v2.2/cloud/project/project-conf-files_services-redis.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ To enable Redis:
2020

2121
```yaml
2222
myredis:
23-
type: redis:5.0
23+
type: redis:<version>
2424
```
2525

2626
To provide your own Redis configuration, add a `core_config` key in your `.magento/services.yaml` file:
2727

2828
```yaml
2929
cache:
30-
type: redis:5.0
30+
type: redis:<version>
3131
```
3232

3333
1. Configure the relationships in the `.magento.app.yaml` file.
@@ -47,7 +47,7 @@ To enable Redis:
4747
git add -A && git commit -m "Enable redis service" && git push origin <branch-name>
4848
```
4949

50-
1. [Verify the relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships).
50+
1. [Verify the service relationships]({{page.baseurl}}/cloud/project/project-conf-files_services.html#service-relationships).
5151

5252
## Using the Redis CLI
5353

@@ -57,6 +57,6 @@ Assuming your Redis relationship is named `redis`, you can access it using the `
5757

5858
1. Open an SSH tunnel to a host.
5959

60-
```bash
61-
redis-cli -h redis.internal
62-
```
60+
```bash
61+
redis-cli -h redis.internal
62+
```

guides/v2.2/cloud/project/project-conf-files_services.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -101,53 +101,60 @@ The current default storage amount per project is 5GB, or 5120MB. You can distri
101101

102102
## Service relationships
103103

104-
{{site.data.var.ece}} uses the [`$MAGENTO_CLOUD_RELATIONSHIPS`]({{page.baseurl}}/cloud/env/environment-vars_cloud.html) environment variable to retrieve environment-related relationships. For services to be available to an application in your project, you must specify [*relationships*]({{ page.baseurl }}/cloud/project/project-conf-files_magento-app.html#relationships) between applications and services in the `.magento.app.yaml` file.
104+
In {{ site.data.var.ece }} projects, service [*relationships*]({{ page.baseurl }}/cloud/project/project-conf-files_magento-app.html#relationships) configured in the `.magento.app.yaml` file determine which services are available to your application.
105+
106+
You can retrieve the configuration data for all service relationships from the [`$MAGENTO_CLOUD_RELATIONSHIPS`]({{page.baseurl}}/cloud/env/environment-vars_cloud.html) environment variable. The configuration data includes service name, type, and version along with any required connection details such as port number and login credentials.
105107

106108
{:.procedure}
107109
To verify relationships in local environment:
108110

109111
1. In your local environment, show the relationships for the active environment.
110112

111-
```bash
112-
magento-cloud relationships
113-
```
113+
```bash
114+
magento-cloud relationships
115+
```
114116

115117
1. Confirm the `service` and `type` from the response. The response provides connection information, such as the IP address and port number.
116118

117-
**Abbreviated sample response**:
118-
119-
```terminal
120-
redis:
121-
-
122-
...
123-
type: 'redis:3.2'
124-
port: 6379
125-
elasticsearch:
126-
-
127-
...
128-
type: 'elasticsearch:6.5'
129-
port: 9200
130-
database:
131-
-
132-
...
133-
type: 'mysql:10.0'
134-
port: 3306
135-
136-
```
137-
{:.no-copy}
119+
**Abbreviated sample response**:
120+
121+
```terminal
122+
redis:
123+
-
124+
...
125+
type: 'redis:3.2'
126+
port: 6379
127+
elasticsearch:
128+
-
129+
...
130+
type: 'elasticsearch:6.5'
131+
port: 9200
132+
database:
133+
-
134+
...
135+
type: 'mysql:10.0'
136+
port: 3306
137+
```
138+
{:.no-copy}
138139

139140
{:.procedure}
140141
To verify relationships in remote environments:
141142

142143
1. Use SSH to log in to the remote environment.
143144

144-
1. Create `pretty-print` to show all relationships for services and configuration data for that environment.
145+
1. List the relationships configuration data for all services configured in the environment.
145146

146-
```bash
147-
php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"])));'
148-
```
147+
```bash
148+
echo $MAGENTO_CLOUD_RELATIONSHIPS | base64 -d | json_pp
149+
```
149150

150-
1. Confirm the `service` and `type` from the response. The response provides connection information, such as the IP address and port number.
151+
or
152+
153+
```bash
154+
php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"])));'
155+
```
156+
157+
1. Confirm the `service` and `type` from the response. The response provides connection information, such as the IP address and port number and any required username and password credentials.
151158

152159
## Service versions
153160

0 commit comments

Comments
 (0)