Commit bd1820ba authored by Daniel Scholl's avatar Daniel Scholl
Browse files

Merge branch 'cleaning-up-manual-documentation' into 'master'

Cleaning up manual documentation

See merge request !34
parents 6de91456 e833e798
......@@ -159,10 +159,9 @@ The script creates some local files to be used.
2. .envrc -- This file is used directory by direnv and requires `direnv allow` to be run to access variables.
3. ~/.ssh/osdu_{UNIQUE}/azure-aks-gitops-ssh-key -- SSH key used by flux.
4. ~/.ssh/osdu_{UNIQUE}/azure-aks-gitops-key.pub -- SSH Public Key used by flux.
5. ~/.ssh/osdu_{UNIQUE}/azure-aks-gitops-key.passphrase -- SSH Key Passphrase used by flux.
6. ~/.ssh/osdu_{UNIQUE}/azure-aks-node-ssh-key -- SSH Key used by AKS
7. ~/.ssh/osdu_{UNIQUE}/azure-aks-node-ssh-key.pub -- SSH Public Key used by AKS
8. ~/.ssh/osdu_{UNIQUE}/azure-aks-node-ssh-key.passphrase -- SSH Key Passphrase used by AKS
5. ~/.ssh/osdu_{UNIQUE}/azure-aks-node-ssh-key -- SSH Key used by AKS
6. ~/.ssh/osdu_{UNIQUE}/azure-aks-node-ssh-key.pub -- SSH Public Key used by AKS
7. ~/.ssh/osdu_{UNIQUE}/azure-aks-node-ssh-key.passphrase -- SSH Key Passphrase used by AKS
> Ensure environment variables are loaded `direnv allow`
......@@ -172,9 +171,9 @@ __Installed Azure Resources__
2. Storage Account
3. Key Vault
4. A principal to be used for Terraform _(Requires Grant Admin Approval)_
5. A principal to be used for the OSDU environment.
6. An application to be used for the OSDU environment. _(future)_
7. An application to be used for negative integration testing.
5. A principal to be used for the OSDU environment _(Requires Grant Admin Approval)_
6. An application to be used for the OSDU environment _(future)_
7. An application to be used for negative integration testing
> Removal would require deletion of all AD elements `osdu-mvp-{UNIQUE}-*`, unlocking and deleting the resource group then purging the KV.
......@@ -249,9 +248,11 @@ __Manual Installation__
3. Upload the Integration Test Data following directions [here](./tools/test_data).
3. Deploy the application helm charts following the directions [here](./charts).
4. Deploy the application helm charts following the directions [here](./charts).
5. Setup Environment Variables for IDE Development and Integration Testing.
5. Register the Data Partition API using the API request located [here](../tools/rest/partition.http).
6. Setup Environment Variables for IDE Development and Integration Testing.
__Automated Pipeline Installation__
......
# Helm Installation Instructions
__DNS Record Setup__
Manually update your DNS A Records to point to the Public IP Address for the environment.
```bash
# Get IP Address
RESOURCE_GROUP=$(az group list --query "[?contains(name, '${UNIQUE}sr')].name" -otsv |grep -v MC)
az network public-ip list --resource-group $RESOURCE_GROUP --query [].ipAddress -otsv
```
__CLI Login__
Login to Azure CLI using the OSDU Environment Service Principal.
......@@ -33,11 +23,10 @@ Create the helm chart values file necessary to install charts.
```bash
# Setup Variables
ISTIO_DASH="<your_dash_login>" # ie: admin
ADMIN_EMAIL="<your_cert_admin>" # ie: admin@email.com
DNS_HOST="<your_ingress_hostname>" # ie: osdu.contoso.com
GROUP=$(az group list --query "[?contains(name, '${UNIQUE}cr')].name" -otsv)
GROUP=$(az group list --query "[?contains(name, 'cr${UNIQUE}')].name" -otsv)
ENV_VAULT=$(az keyvault list --resource-group $GROUP --query [].name -otsv)
# Translate Values File
......@@ -78,8 +67,8 @@ global:
# based64 encoded username and password
#
istio:
username: $(echo $ISTIO_DASH | base64)
password: $(echo $ISTIO_DASH | base64)
username: $(az keyvault secret show --id https://${COMMON_VAULT}.vault.azure.net/secrets/istio-username --query value -otsv)
password: $(az keyvault secret show --id https://${COMMON_VAULT}.vault.azure.net/secrets/istio-password --query value -otsv)
EOF
```
......@@ -97,7 +86,6 @@ git clone https://community.opengroup.org/osdu/platform/system/storage.git $SRC_
git clone https://community.opengroup.org/osdu/platform/system/indexer-queue.git $SRC_DIR/indexer-queue
git clone https://community.opengroup.org/osdu/platform/system/indexer-service.git $SRC_DIR/indexer-service
git clone https://community.opengroup.org/osdu/platform/system/search-service.git $SRC_DIR/search-service
git clone https://community.opengroup.org/osdu/platform/system/delivery.git $SRC_DIR/delivery
```
......@@ -108,7 +96,7 @@ __Kubernetes API Access__
It can often be helpful to be able to retrieve the cluster context and execute queries directly against the Kubernetes API.
```bash
BASE_NAME=$(az group list --query "[?contains(name, '${UNIQUE}sr')].name" -otsv |grep -v MC | rev | cut -c 3- | rev)
BASE_NAME=$(az group list --query "[?contains(name, 'sr${UNIQUE}')].name" -otsv |grep -v MC | rev | cut -c 3- | rev)
az aks get-credentials -n ${BASE_NAME}aks -g ${BASE_NAME}rg
```
......
......@@ -4,6 +4,6 @@ Manually update your DNS A Records to point to the Public IP Address for the env
```bash
# Get IP Address
RESOURCE_GROUP=$(az group list --query "[?contains(name, '${UNIQUE}sr')].name" -otsv |grep -v MC)
RESOURCE_GROUP=$(az group list --query "[?contains(name, 'sr${UNIQUE}')].name" -otsv |grep -v MC)
az network public-ip list --resource-group $RESOURCE_GROUP --query [].ipAddress -otsv
```
```
\ No newline at end of file
......@@ -43,6 +43,6 @@ EOF
__Retrieve Additional Values__
The `INITIAL_TOKEN` is an open id token. Follow the directions in osduauth to obtain a token and once obtained save the value in settings.
The `INITIAL_TOKEN` is an open id token. Follow the directions in [osduauth](./osduauth) to obtain a token and once obtained save the value in settings.
The `OSDU_HOST` is your FQDN for your osdu environment.
......@@ -7,7 +7,7 @@ __Create the HTML File__
# This logs your local Azure CLI in using the configured service principal.
az login --service-principal -u $ARM_CLIENT_ID -p $ARM_CLIENT_SECRET --tenant $ARM_TENANT_ID
GROUP=$(az group list --query "[?contains(name, '${UNIQUE}cr')].name" -otsv)
GROUP=$(az group list --query "[?contains(name, 'cr${UNIQUE}')].name" -otsv)
ENV_VAULT=$(az keyvault list --resource-group $GROUP --query [].name -otsv)
CLIENT_ID=$(az keyvault secret show --id https://${ENV_VAULT}.vault.azure.net/secrets/aad-client-id --query value -otsv)
......
......@@ -61,6 +61,7 @@ These files need to be uploaded into the proper Cosmos Collections with the requ
- storage_schema_10.json
- storage_schema_11.json
> NOTE: If you are doing a manual deployment, your partition name is "opendes" by default
```bash
# Retrieve Values from Common Key Vault
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment