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

Jump to bottom

Migrate removed networking variables #900

Merged
merged 4 commits into from
Nov 9, 2023
Merged

Migrate removed networking variables #900

merged 4 commits into from
Nov 9, 2023

Conversation

joe4dev
Copy link
Member

@joe4dev joe4dev commented Nov 8, 2023

  • Remove/migrate edge variables EDGE_PORT/EDGE_PORT_HTTP/EDGE_BIND_HOST. All write-usages. Few read-usages remain until the respective integration tools are updated to adopt AWS_ENDPOINT_URL
  • Un-deprecate USE_SSL and describe its current usage
  • Remove <SERVICE>_PORT_EXTERNAL

@joe4dev joe4dev requested a review from simonrw November 8, 2023 22:35
@joe4dev joe4dev self-assigned this Nov 8, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 8, 2023 •
edited
Loading

⚡️ Deploying PR Preview...

simonrw
simonrw requested changes Nov 8, 2023
View reviewed changes
Copy link
Contributor

@simonrw simonrw left a comment

Choose a reason for hiding this comment

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

We need to update usages of e.g. HOSTNAME_EXTERNAL and other deprecated variables from the main text as well as the configuration section. There are a few references to HOSTNAME_EXTERNAL but we need to replace LOCALSTACK_HOSTNAME as well (unless used in a read-only capacity).

In addition, could we make a change to the FAQ entry about "Why can’t my other Docker containers reach LocalStack?"? Perhaps keep the first paragraph, but remove the remaining text and link to the network troubleshooting guide?

content/en/references/configuration.md Outdated Show resolved Hide resolved
@joe4dev
Copy link
Member Author

joe4dev commented Nov 8, 2023

We need to update usages of e.g. HOSTNAME_EXTERNAL and other deprecated variables from the main text as well as the configuration section. There are a few references to HOSTNAME_EXTERNAL but we need to replace LOCALSTACK_HOSTNAME as well (unless used in a read-only capacity).

Correct, that's quite some usage.
I replace them except for transparent endpoint injection (done in the Lambda PR #899) and LocalStack tools that do not yet support AWS_ENDPOINT_URL (I added them to the task list in the decision doc).

In addition, could we make a change to the FAQ entry about "Why can’t my other Docker containers reach LocalStack?"? Perhaps keep the first paragraph, but remove the remaining text and link to the network troubleshooting guide?

Good suggestion, done 👍

@joe4dev joe4dev mentioned this pull request Nov 8, 2023
Merged
15 tasks
joe4dev
joe4dev commented Nov 8, 2023
View reviewed changes
content/en/user-guide/aws/elastic-kubernetes-service/index.md
@@ -100,12 +100,13 @@ You can now use ECR (Elastic Container Registry) images within your EKS environm

#### Initial configuration

To modify the return value of resource URIs for most services, including ECR, you can utilize the `HOSTNAME_EXTERNAL` variable in the [configuration]({{< ref "configuration" >}}). By default, ECR returns a `repositoryUri` starting with `localhost`, such as: `localhost:<port>/<repository-name>`. However, if you set the `HOSTNAME_EXTERNAL` to `localhost.localstack.cloud`, the ECR will provide a `repositoryUri` like `localhost.localstack.cloud:<port>/<repository_name>`.
To modify the return value of resource URIs for most services, including ECR, you can utilize the `LOCALSTACK_HOST` variable in the [configuration]({{< ref "configuration" >}}).
By default, ECR returns a `repositoryUri` starting with `localhost.localstack.cloud`, such as: `localhost.localstack.cloud:<port>/<repository-name>`.
Copy link
Member Author

Choose a reason for hiding this comment

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

@simonrw That's the new default, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes this is correct

joe4dev
joe4dev commented Nov 8, 2023
View reviewed changes
content/en/user-guide/ci/gitlab-ci/index.md
@@ -62,6 +60,13 @@ test:
- aws --endpoint http://localhost.localstack.cloud:4566 s3 ls s3://test/
```

<details>
<summary>For LocalStack versions before 3.0.0</summary>
Copy link
Member Author

Choose a reason for hiding this comment

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

looks a bit awkward but probably needed

@joe4dev joe4dev requested a review from simonrw November 8, 2023 23:41
@alexrashed alexrashed force-pushed the remove-ignored-networking-configuration branch from 8ebba3b to 31ca2f7 Compare November 9, 2023 06:12
simonrw
simonrw approved these changes Nov 9, 2023
View reviewed changes
Copy link
Contributor

@simonrw simonrw left a comment

Choose a reason for hiding this comment

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

Looks great, thanks a lot for taking care of this migration. It's exciting to be able to remove HOSTNAME_EXTERNAL and LOCALSTACK_HOSTNAME from our docs!

@joe4dev joe4dev merged commit a7c815e into release/v3.0 Nov 9, 2023
2 checks passed
@joe4dev joe4dev deleted the remove-ignored-networking-configuration branch November 9, 2023 10:28
@dominikschubert dominikschubert mentioned this pull request Nov 20, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonrw simonrw simonrw approved these changes

@thrau thrau Awaiting requested review from thrau

@baermat baermat Awaiting requested review from baermat

@steffyP steffyP Awaiting requested review from steffyP

@viren-nadkarni viren-nadkarni Awaiting requested review from viren-nadkarni

Assignees

@joe4dev joe4dev

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@joe4dev @simonrw