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

replace all instances of example.com with default.domain #631

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ Deployment steps:
- account-pages: updated to latest app (#175)

## Other updates
- Standardise docs to use example.com everywhere (#161, #172)
- Standardise docs to use example.com everywhere (#161, #172). (Note, 5 July 2022, example.com replaced with default.domain globally in both wire-server and wire-server-deploy, this instance excluded as it's historical)
- Cleaned up and moved docs around to wire-docs (#157)

## Breaking changes / known issues when upgrading
Expand Down
6 changes: 3 additions & 3 deletions ansible/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ like this:
```yaml
sft_servers_blue:
vars:
sft_artifact_file_url: "https://example.com/path/to/sftd_42.tar.gz"
sft_artifact_file_url: "https://default.domain/path/to/sftd_42.tar.gz"
sft_artifact_checksum: somechecksum_42
srv_announcer_active: true
```
Expand All @@ -101,7 +101,7 @@ For `sft_servers_green`, `srv_announcer_active` must be `false`.
```yaml
sft_servers_green:
vars:
sft_artifact_file_url: "https://example.com/path/to/sftd_44.tar.gz"
sft_artifact_file_url: "https://default.domain/path/to/sftd_44.tar.gz"
sft_artifact_checksum: somechecksum_44
srv_announcer_active: true
```
Expand All @@ -122,7 +122,7 @@ For `sft_servers_green`, `srv_announcer_active` must be `false`.
```yaml
sft_servers_blue:
vars:
sft_artifact_file_url: "https://example.com/path/to/sftd_42.tar.gz"
sft_artifact_file_url: "https://default.domain/path/to/sftd_42.tar.gz"
sft_artifact_checksum: somechecksum_42
srv_announcer_active: false
```
Expand Down
4 changes: 2 additions & 2 deletions ansible/inventory/demo/hosts.example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ kubeconfig_localhost = True

[minio:vars]
prefix = "example-"
domain = "example.com"
deeplink_title = "example.com environment"
domain = "default.domain"
deeplink_title = "default.domain environment"

4 changes: 2 additions & 2 deletions ansible/inventory/offline/99-static
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@

### No longer used. generated by the nginz section of values/wire-server/values.yaml instead.
#prefix = "example-"
#domain = "example.com"
#deeplink_title = "example.com environment"
#domain = "default.domain"
#deeplink_title = "default.domain environment"

[restund:vars]
# Uncomment if your public IP is not on the default gateway
Expand Down
6 changes: 3 additions & 3 deletions ansible/inventory/prod/hosts.example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ minio03
minio_access_key = "REPLACE_THIS_WITH_THE_DESIRED_ACCESS_KEY"
minio_secret_key = "REPLACE_THIS_WITH_THE_DESIRED_SECRET_KEY"
prefix = "example-"
domain = "example.com"
deeplink_title = "example.com environment"
domain = "default.domain"
deeplink_title = "default.domain environment"

[restund]
restund01
Expand Down Expand Up @@ -118,7 +118,7 @@ ansible_python_interpreter = /usr/bin/python3
# ansible_become_pass = ...

## if the servers need a proxy to access the Internet, configure it here:
# proxy_env = "{'http_proxy': 'http://proxy.example.com:8080', 'https_proxy': 'http://proxy.example.com:8080'}"
# proxy_env = "{'http_proxy': 'http://proxy.default.domain:8080', 'https_proxy': 'http://proxy.default.domain:8080'}"

### CASSANDRA section ###

Expand Down
4 changes: 2 additions & 2 deletions ansible/kube-minio-static-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@
# FUTUREWORK: parse them from a configuration file shared with helm
# (as the domain needs to be known in helm override values.yaml)
prefix: "{{ minio_deeplink_prefix | default('example-') }}"
domain: "{{ minio_deeplink_domain | default('example.com') }}"
deeplink_title: "{{ minio_deeplink_domain | default('example.com environment') }}"
domain: "{{ minio_deeplink_domain | default('default.domain') }}"
deeplink_title: "{{ minio_deeplink_domain | default('default.domain environment') }}"
4 changes: 2 additions & 2 deletions ansible/minio.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,5 @@
# FUTUREWORK: parse them from a configuration file shared with helm
# (as the domain needs to be known in helm override values.yaml)
prefix: "{{ minio_deeplink_prefix | default('example-') }}"
domain: "{{ minio_deeplink_domain | default('example.com') }}"
deeplink_title: "{{ minio_deeplink_domain | default('example.com environment') }}"
domain: "{{ minio_deeplink_domain | default('default.domain') }}"
deeplink_title: "{{ minio_deeplink_domain | default('default.domain environment') }}"
2 changes: 1 addition & 1 deletion ansible/roles/minio-static-files/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This role requires the following variables to be set:
#
#prefix: example-
#domain: example.com
#domain: default.domain
#deeplink_title: Example Environment

assetsURL: "https://{{ prefix }}assets.{{ domain }}"
Expand Down
12 changes: 6 additions & 6 deletions examples/team-provisioning-qr-codes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The script reads configuration from a series of environment variables:
- `DEEPLINK_URL`: the URL for the private Wire server's deeplink. See [this
page](https://docs.wire.com/how-to/associate/deeplink.html) for further
information on using deeplinks with private Wire instances. Example:
`https://assets.wire.example.com/public/deeplink.html`.
`https://assets.wire.default.domain/public/deeplink.html`.

- `INSTRUCTIONS`: path to a file containing administrator-provided setup
instructions to be included in the generated PDF. The contents of this file
Expand All @@ -82,19 +82,19 @@ An example invocation of the script could look like this:

``` sh
$ cat > instructions.txt <<EOF
These are instructions for onboarding into example.com's private Wire
These are instructions for onboarding into default.domain's private Wire
server. Please scan the invite QR code on your mobile device, and create an
account using the email address listed below. Then, please install the Wire
application for your mobile device, and then scan the deeplink QR code and
open the link on that page in order to configure your client to work with
example.com's Wire server.
default.domain's Wire server.
EOF
$
$ export TEAM_ADMIN_EMAIL="someone@example.com"
$ export TEAM_ADMIN_EMAIL="someone@default.domain"
$ export TEAM_ADMIN_PASSWORD="password"
$ export TEAM_ID="9cabf984-7a35-4cd5-9891-850c64f9195a"
$ export NGINZ_HOST="nginz-https.wire.example.com"
$ export DEEPLINK_URL="https://assets.wire.example.com/public/deeplink.html"
$ export NGINZ_HOST="nginz-https.wire.default.domain"
$ export DEEPLINK_URL="https://assets.wire.default.domain/public/deeplink.html"
$ export INSTRUCTIONS=./instructions.txt
$
$ ./generate-user-pdf.sh [email protected]
Expand Down
6 changes: 3 additions & 3 deletions examples/team-provisioning-qr-codes/generate-user-pdf.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
# The following environment variables must be set in order to query invitations
# links via teams API and generate invite and deeplink QR codes:
#
# TEAM_ADMIN_EMAIL="someone@example.com"
# TEAM_ADMIN_EMAIL="someone@default.domain"
# TEAM_ADMIN_PASSWORD="password"
# TEAM_ID="9cabf984-7a35-4cd5-9891-850c64f9195a"
# NGINZ_HOST="nginz-https.wire.example.com"
# DEEPLINK_URL="https://assets.wire.example.com/public/deeplink.html"
# NGINZ_HOST="nginz-https.wire.default.domain"
# DEEPLINK_URL="https://assets.wire.default.domain/public/deeplink.html"
# INSTRUCTIONS=./instructions.txt
#
# This script is called with the email address of the user to create:
Expand Down
10 changes: 5 additions & 5 deletions offline/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ the `wire.com/external-ip` annotation to the public IP of the node.

### Configuring MinIO

In order to automatically generate deeplinks, Edit the minio variables in `[minio:vars]` (`prefix`, `domain` and `deeplink_title`) by replacing `example.com` with your own domain.
In order to automatically generate deeplinks, Edit the minio variables in `[minio:vars]` (`prefix`, `domain` and `deeplink_title`) by replacing `default.domain` with your own domain.

## Generating secrets

Expand Down Expand Up @@ -351,10 +351,10 @@ Open up `./values/wire-server/secrets.yaml` and inspect the values. In theory
this file should have only generated secrets, and no additional secrets have to
be added, unless additional options have been enabled.

Open up `./values/wire-server/values.yaml` and replace example.com and other domains and subdomain with your domain. You can do it with:
Open up `./values/wire-server/values.yaml` and replace default.domain and other domains and subdomain with your domain. You can do it with:

```
sed -i 's/example.com/<your-domain>/g' values.yaml
sed -i 's/default.domain/<your-domain>/g' values.yaml
```


Expand Down Expand Up @@ -527,7 +527,7 @@ edit values/nginx-ingress-services/values.yaml , to tell ingress-ingress-service

set your domain name with sed:
```
sed -i "s/example.com/YOURDOMAINHERE/" values/nginx-ingress-services/values.yaml
sed -i "s/default.domain/YOURDOMAINHERE/" values/nginx-ingress-services/values.yaml
```

UNDER CONSTRUCTION:
Expand Down Expand Up @@ -585,7 +585,7 @@ d kubectl label node kubenode1 wire.com/role=sftd
```

##### A selected group of kubernetes nodes:
If you are restricting SFT to certain nodes, use `nodeSelector` to run on specific nodes (**replacing the example.com domains with yours**):
If you are restricting SFT to certain nodes, use `nodeSelector` to run on specific nodes (**replacing the default.domain domains with yours**):
```
d helm upgrade --install sftd ./charts/sftd \
--set 'nodeSelector.wire\.com/role=sftd' \
Expand Down
6 changes: 3 additions & 3 deletions offline/ldap-scim-bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ config:
logLevel: "Debug" # one of Trace,Debug,Info,Warn,Error,Fatal; Fatal is least noisy, Trace most.
ldapSource:
tls: true
host: "dc1.example.com"
host: "dc1.default.domain"
port: 636
dn: "CN=Read Only User,CN=users,DC=example,DC=com"
password: "READONLYPASSWORD"
Expand Down Expand Up @@ -121,15 +121,15 @@ For active Directory:
```
ldapSource:
tls: true
host: "dc1.example.com"
host: "dc1.default.domain"
port: 636
dn: "CN=Wire RO,CN=users,DC=com,DC=example"
password: "SECRETPASSWORDHERE"
```

### Pick your users

Select the user group you want to sync. for example, to find all of the people in the engineering department of the example.com AD domain:
Select the user group you want to sync. for example, to find all of the people in the engineering department of the default.domain AD domain:

```
search:
Expand Down
8 changes: 4 additions & 4 deletions offline/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,17 +410,17 @@ If you are restricting SFT to certain nodes, use `nodeSelector` to run on specif
```
d helm upgrade --install sftd ./charts/sftd \
--set 'nodeSelector.wire\.com/role=sftd' \
--set host=sftd.example.com \
--set allowOrigin=https://webapp.example.com \
--set host=sftd.default.domain \
--set allowOrigin=https://webapp.default.domain \
--set-file tls.crt=/path/to/tls.crt \
--set-file tls.key=/path/to/tls.key
```

If you are not doing that, omit the `nodeSelector` argument:
```
d helm upgrade --install sftd ./charts/sftd \
--set host=sftd.example.com \
--set allowOrigin=https://webapp.example.com \
--set host=sftd.default.domain \
--set allowOrigin=https://webapp.default.domain \
--set-file tls.crt=/path/to/tls.crt \
--set-file tls.key=/path/to/tls.key
```
4 changes: 2 additions & 2 deletions terraform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Run all commands from `terraform/environment` directory.
`$ENV_DIR/operator-ssh.dec`<sup>[1]</sup>. Example:

```bash
ssh-keygen -o -a 100 -t ed25519 -f "$ENV_DIR/operator-ssh.dec" -C "example@example.com"
ssh-keygen -o -a 100 -t ed25519 -f "$ENV_DIR/operator-ssh.dec" -C "example@default.domain"
# see footnote 2 if you're a wire employee
```
1. (optional) encrypt files if collaborating using SOPS:
Expand All @@ -50,7 +50,7 @@ Run all commands from `terraform/environment` directory.
1. Create variables for the environment in `$ENV_DIR/terraform.tfvars`, example:
```tf
environment = <env>
root_domain = "example.com"
root_domain = "default.domain"
operator_ssh_public_keys = {
terraform_managed = {
"<key name>" = "<public key from step above>"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module "brig_prekey_lock_and_event_queue_emailing" {
environment = "staging"

zone_id = "Z12345678SQWERTYU"
domain = "example.com"
domain = "default.domain"
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ variable "zone_id" {
}
variable "domain" {
type = string
description = "FQDN of the email address that is used in 'From' when sending emails (example: example.com)"
description = "FQDN of the email address that is used in 'From' when sending emails (example: default.domain)"
default = null
}

Expand Down
20 changes: 10 additions & 10 deletions terraform/modules/aws-dns-records/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ AWS resources: route53

#### How to use the module

Assuming you already have a root zone with fqdn `example.com` in route53 setup elsewhere, example usage:
Assuming you already have a root zone with fqdn `default.domain` in route53 setup elsewhere, example usage:

```hcl
module "dns_records" {
source = "github.com/wireapp/wire-server-deploy.git//terraform/modules/aws-dns-records?ref=CHANGE-ME"

zone_fqdn = "example.com"
zone_fqdn = "default.domain"
domain = "staging"
sub_domains = [
"nginz-https",
Expand All @@ -41,16 +41,16 @@ module "dns_records" {

This creates entries for the following FQDNs:

* `nginz-https.staging.example.com`
* `nginz-ssl.staging.example.com`
* `webapp.staging.example.com`
* `assets.staging.example.com`
* `account.staging.example.com`
* `teams.staging.example.com`
* `nginz-https.staging.default.domain`
* `nginz-ssl.staging.default.domain`
* `webapp.staging.default.domain`
* `assets.staging.default.domain`
* `account.staging.default.domain`
* `teams.staging.default.domain`

It also creates a TXT SPF record for your mail server on `staging.example.com` with a value `"v=spf1 ip4:9.9.9.10 ip4:23.42.23.42 -all"`
It also creates a TXT SPF record for your mail server on `staging.default.domain` with a value `"v=spf1 ip4:9.9.9.10 ip4:23.42.23.42 -all"`

As well as an SRV record `_wire-server._tcp.staging.example.com` pointing to `0 10 443 nginz-https.staging.example.com`
As well as an SRV record `_wire-server._tcp.staging.default.domain` pointing to `0 10 443 nginz-https.staging.default.domain`

These sub-domains represent the primary set of FQDNs used in a
[`wire-server` installation](https://docs.wire.com/how-to/install/helm-prod.html#how-to-set-up-dns-records),
Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/aws-dns-records/variables.tf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
variable "zone_fqdn" {
type = string
description = "FQDN of the DNS zone root (required; example: example.com; will append: '.')"
description = "FQDN of the DNS zone root (required; example: default.domain; will append: '.')"
}

variable "domain" {
Expand Down
2 changes: 1 addition & 1 deletion values/ldap-scim-bridge/values-prod.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ config:
logLevel: "Debug" # one of Trace,Debug,Info,Warn,Error,Fatal; 'Fatal' is least noisy, 'Trace' is most.
ldapSource:
tls: true
host: "ldap-server.example.com"
host: "ldap-server.default.domain"
port: 636
dn: "CN=Admin,DC=example,DC=com"
password: "secret password here"
Expand Down
12 changes: 6 additions & 6 deletions values/nginx-ingress-services/demo-values.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ certManager:
# NOTE: These values must be adjusted on a per installation basis
config:
dns:
https: nginz-https.example.com
ssl: nginz-ssl.example.com
webapp: webapp.example.com
fakeS3: assets.example.com
teamSettings: teams.example.com
accountPages: account.example.com
https: nginz-https.default.domain
ssl: nginz-ssl.default.domain
webapp: webapp.default.domain
fakeS3: assets.default.domain
teamSettings: teams.default.domain
accountPages: account.default.domain
12 changes: 6 additions & 6 deletions values/nginx-ingress-services/prod-values.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ certManager:
# should be adjusted on a per installation basis
config:
dns:
https: nginz-https.example.com
ssl: nginz-ssl.example.com
webapp: webapp.example.com
fakeS3: assets.example.com
teamSettings: teams.example.com
accountPages: account.example.com
https: nginz-https.default.domain
ssl: nginz-ssl.default.domain
webapp: webapp.default.domain
fakeS3: assets.default.domain
teamSettings: teams.default.domain
accountPages: account.default.domain

service:
s3:
Expand Down
4 changes: 2 additions & 2 deletions values/sftd/prod-values.example.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
allowOrigin: https://webapp.example.com
host: sftd.example.com
allowOrigin: https://webapp.default.domain
host: sftd.default.domain
tls:
issuerRef:
name: letsencrypt-prod
Loading