From 652347d88d9367d94700f7e727a27cce14082b5c Mon Sep 17 00:00:00 2001 From: Nitin Aggarwal Date: Thu, 4 Aug 2022 11:12:25 -0700 Subject: [PATCH] replace docs reference --- .circleci/config.yml | 4 ++-- .circleci/src/jobs/download-opta-version.yaml | 4 ++-- .circleci/src/jobs/download-opta.yaml | 4 ++-- .github/workflows/update-latest.yml | 2 +- README.md | 18 +++++++++--------- UPGRADING.md | 4 ++-- config/registry/aws/eks_upgrade.md | 4 ++-- examples/README.md | 2 +- examples/byok-eks/README.md | 4 ++-- examples/flyte/flyte-aws.yaml | 2 +- examples/full-stack-example/README.md | 2 +- examples/grpcbin/README.md | 4 ++-- examples/minecraft/README.md | 4 ++-- examples/nocodb/nocodb-aws.yaml | 2 +- examples/opta-mern-stack/README.md | 12 ++++++------ modules/aws_k8s_service/aws-k8s-service.json | 12 ++++++------ modules/aws_k8s_service/aws-k8s-service.yaml | 10 +++++----- .../azure_k8s_service/azure-k8s-service.json | 12 ++++++------ .../azure_k8s_service/azure-k8s-service.yaml | 10 +++++----- .../cloudfront_distribution/tf_module/main.tf | 2 +- modules/gcp_k8s_service/gcp-k8s-service.json | 12 ++++++------ modules/gcp_k8s_service/gcp-k8s-service.yaml | 10 +++++----- opta/cli.py | 2 +- opta/commands/deploy.py | 4 ++-- opta/commands/secret.py | 2 +- opta/commands/upgrade.py | 2 +- opta/constants.py | 2 +- opta/core/terraform.py | 2 +- opta/core/upgrade.py | 2 +- opta/layer.py | 2 +- tests/core/test_terraform.py | 4 ++-- 31 files changed, 81 insertions(+), 81 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index d9020d5ed..4796239db 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1561,7 +1561,7 @@ jobs: git config --global user.name "Runx CI" name: Set git user - run: - command: /bin/bash -c "$(curl -fsSL https://docs.opta.dev/install.sh)" + command: /bin/bash -c "$(curl -fsSL http://run-x.gihub.io/install.sh)" name: Download Latest Opta Binary - install-opta-dependencies - run: @@ -1586,7 +1586,7 @@ jobs: git config --global user.name "Runx CI" name: Set git user - run: - command: VERSION=<< parameters.opta-version >> /bin/bash -c "$(curl -fsSL https://docs.opta.dev/install.sh)" + command: VERSION=<< parameters.opta-version >> /bin/bash -c "$(curl -fsSL http://run-x.gihub.io/install.sh)" name: Download Latest Opta Binary - install-opta-dependencies - run: diff --git a/.circleci/src/jobs/download-opta-version.yaml b/.circleci/src/jobs/download-opta-version.yaml index 72becd964..40b6e87cc 100644 --- a/.circleci/src/jobs/download-opta-version.yaml +++ b/.circleci/src/jobs/download-opta-version.yaml @@ -12,7 +12,7 @@ steps: git config --global user.name "Runx CI" - run: name: "Download Latest Opta Binary" - command: VERSION=<< parameters.opta-version >> /bin/bash -c "$(curl -fsSL https://docs.opta.dev/install.sh)" + command: VERSION=<< parameters.opta-version >> /bin/bash -c "$(curl -fsSL http://run-x.gihub.io/install.sh)" - install-opta-dependencies - run: name: "Check Opta Version" @@ -21,4 +21,4 @@ steps: - persist_to_workspace: root: ~/ paths: - - .opta \ No newline at end of file + - .opta diff --git a/.circleci/src/jobs/download-opta.yaml b/.circleci/src/jobs/download-opta.yaml index 55854d51a..35467ca7e 100644 --- a/.circleci/src/jobs/download-opta.yaml +++ b/.circleci/src/jobs/download-opta.yaml @@ -9,7 +9,7 @@ steps: git config --global user.name "Runx CI" - run: name: "Download Latest Opta Binary" - command: /bin/bash -c "$(curl -fsSL https://docs.opta.dev/install.sh)" + command: /bin/bash -c "$(curl -fsSL http://run-x.gihub.io/install.sh)" - install-opta-dependencies - run: name: "Check Opta Version" @@ -18,4 +18,4 @@ steps: - persist_to_workspace: root: ~/ paths: - - .opta \ No newline at end of file + - .opta diff --git a/.github/workflows/update-latest.yml b/.github/workflows/update-latest.yml index db614aec4..48be7af88 100644 --- a/.github/workflows/update-latest.yml +++ b/.github/workflows/update-latest.yml @@ -13,7 +13,7 @@ jobs: steps: - name: validate version run: | - /bin/bash -c "$(curl -fsSL https://docs.opta.dev/install.sh)" + /bin/bash -c "$(curl -fsSL http://run-x.gihub.io/install.sh)" export VERSION_FOUND=$(/home/runner/.opta/opta version | head -n 1) if [ "$VERSION" = "$VERSION_FOUND" ]; then echo "Valid version" diff --git a/README.md b/README.md index 913752a80..88b41e61d 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Automated, secure, scalable cloud infrastructure

- Documentation | + Documentation | Slack Community | @@ -53,7 +53,7 @@ fast moving organizations. Opta is currently being used by dozens of companies o To read more about the vision behind Opta, check out this [blog post](https://blog.runx.dev/infrastructure-as-code-for-everyone-7dad6b813cbc). -If you'd like to try it out or have any questions - feel free to join our [Slack](https://slack.opta.dev/) or explore the [Getting Started Guide](https://docs.opta.dev/getting-started)! +If you'd like to try it out or have any questions - feel free to join our [Slack](https://slack.opta.dev/) or explore the [Getting Started Guide](http://run-x.gihub.io/getting-started)!

@@ -67,7 +67,7 @@ If you'd like to try it out or have any questions - feel free to join our [Slack ### Cloud services Opta supports the 3 major clouds - AWS, GCP and Azure. It has modules for the most commonly used services in these clouds like: -* Microservices (powered by [Kubernetes](https://docs.opta.dev/architecture/aws/)) +* Microservices (powered by [Kubernetes](http://run-x.gihub.io/architecture/aws/)) * Databases - Postgres, MySQL, Redis * Serverless workloads * Networking - VPCs, Subnets, Load balancers @@ -75,10 +75,10 @@ Opta supports the 3 major clouds - AWS, GCP and Azure. It has modules for the mo * Object storage (S3, GCS) Additionally, Opta has cloud and security best practices built in, including: -* [Observability](https://docs.opta.dev/features/observability/) (Datadog, LogDNA) -* [SOC2 compliance](https://docs.opta.dev/compliance/) -* [Continuous Deployment](https://docs.opta.dev/features/continuous_deployment/) -* Hardened network and security configurations ([AWS](https://docs.opta.dev/architecture/aws/), [GCP](https://docs.opta.dev/architecture/gcp/), [Azure](https://docs.opta.dev/architecture/azure)) +* [Observability](http://run-x.gihub.io/features/observability/) (Datadog, LogDNA) +* [SOC2 compliance](http://run-x.gihub.io/compliance/) +* [Continuous Deployment](http://run-x.gihub.io/features/continuous_deployment/) +* Hardened network and security configurations ([AWS](http://run-x.gihub.io/architecture/aws/), [GCP](http://run-x.gihub.io/architecture/gcp/), [Azure](http://run-x.gihub.io/architecture/azure)) * Auto-scaling and high availability (HA) @@ -86,13 +86,13 @@ Additionally, Opta has cloud and security best practices built in, including: Opta aims to be compatible with your existing infrastructure setup. You can: * Import existing Terraform infrastructure into Opta -* Write [custom Terraform modules](https://docs.opta.dev/reference/aws/modules/custom-terraform/) (for services that Opta doesn't support yet) +* Write [custom Terraform modules](http://run-x.gihub.io/reference/aws/modules/custom-terraform/) (for services that Opta doesn't support yet) * Run Opta in existing VPCs (WIP) * Export the generated Terraform # Try out Opta -Check out the [Getting Started Guide](https://docs.opta.dev/getting-started/). +Check out the [Getting Started Guide](http://run-x.gihub.io/getting-started/). You can also explore some [examples](https://github.com/run-x/opta/tree/main/examples) to get a better idea of what you can do with Opta. diff --git a/UPGRADING.md b/UPGRADING.md index fba76d0c3..b247fe5e6 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -9,10 +9,10 @@ In some rare cases, upgrading an Opta version can cause a few minutes of downtim ## Upgrading Kubernetes version ### AWS -Checkout our AWS EKS version upgrade guide [here](https://docs.opta.dev/reference/aws/eks_upgrade/) +Checkout our AWS EKS version upgrade guide [here](http://run-x.gihub.io/reference/aws/eks_upgrade/) ### GCP -Checkout our GCP GKE version upgrade guide [here](https://docs.opta.dev/reference/google/gke_upgrade/) +Checkout our GCP GKE version upgrade guide [here](http://run-x.gihub.io/reference/google/gke_upgrade/) ## Upgrading database version diff --git a/config/registry/aws/eks_upgrade.md b/config/registry/aws/eks_upgrade.md index 94822885e..3979c5a24 100644 --- a/config/registry/aws/eks_upgrade.md +++ b/config/registry/aws/eks_upgrade.md @@ -97,7 +97,7 @@ To do so, set the `k8s_version` field in the `k8s-cluster` block of your environ **NOTE**: The `k8s_version` field may not be currently specified in your yaml as it comes with a default. Opta continuously updates this default but in order to not force downtime on the users the changes in the default do not -affect existing clusters, only new ones. Please refer to [here](https://docs.opta.dev/reference/aws/modules/aws-eks/) +affect existing clusters, only new ones. Please refer to [here](http://run-x.gihub.io/reference/aws/modules/aws-eks/) for more details of the `k8s-cluster` block. For example, if you just upgraded to kubernetes version 1.21, then your environment yaml may change from looking like @@ -150,4 +150,4 @@ No breaking changes or extra steps identified. You're good to go. ### References https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html -https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html \ No newline at end of file +https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html diff --git a/examples/README.md b/examples/README.md index 19c949190..5b8feb4b7 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,6 @@ # opta-examples This directory holds a compiled list of advanced, standalone, usages of Opta, most beyond the basic tutorials on the -[docs](https://docs.opta.dev/) +[docs](http://run-x.gihub.io/) - [airflow](/examples/airflow): Deploy Apache Airflow on AWS - [aws-lambda](/examples/aws-lambda): Deploy Apache Airflow on AWS diff --git a/examples/byok-eks/README.md b/examples/byok-eks/README.md index 0da0d9baf..c74b9197c 100644 --- a/examples/byok-eks/README.md +++ b/examples/byok-eks/README.md @@ -4,7 +4,7 @@ This is an example of using [Opta](https://github.com/run-x/opta) with an existi # What does this do? -This example provides Terraform files to configure Linkerd and Ingress Nginx controller in your EKS cluster to have the target [Network Architecture](https://docs.opta.dev/features/networking/network_overview/). +This example provides Terraform files to configure Linkerd and Ingress Nginx controller in your EKS cluster to have the target [Network Architecture](http://run-x.gihub.io/features/networking/network_overview/). Once EKS is configured, you will be able to use Opta to deploy your service to Kubernetes. Opta will generate the Terraform files and Helm chart for you, you only need to maintain the Opta file. @@ -14,7 +14,7 @@ Opta will generate the Terraform files and Helm chart for you, you only need to # When to use this instead of full Opta? - Use this guide if you already have an EKS cluster, and would like to use Opta to deploy your Kubernetes services. -- If you don't have an EKS cluser, Opta can create it, check [Getting Started](https://docs.opta.dev/getting-started/) instead. +- If you don't have an EKS cluser, Opta can create it, check [Getting Started](http://run-x.gihub.io/getting-started/) instead. # What is included? diff --git a/examples/flyte/flyte-aws.yaml b/examples/flyte/flyte-aws.yaml index c94ed423f..bf7fd1950 100644 --- a/examples/flyte/flyte-aws.yaml +++ b/examples/flyte/flyte-aws.yaml @@ -8,7 +8,7 @@ modules: - type: base - type: dns domain: <> - delegated: false # set to true once ready https://docs.opta.dev/miscellaneous/ingress/ + delegated: false # set to true once ready http://run-x.gihub.io/miscellaneous/ingress/ - type: k8s-cluster max_nodes: 15 - type: k8s-base diff --git a/examples/full-stack-example/README.md b/examples/full-stack-example/README.md index d7043bc9f..3ab66bdd2 100644 --- a/examples/full-stack-example/README.md +++ b/examples/full-stack-example/README.md @@ -127,7 +127,7 @@ opta destroy --config full-stack-example/providers/aws.yaml --auto-approve # Further Reading -Visit [Opta Documentation](https://docs.opta.dev/) to learn more. +Visit [Opta Documentation](http://run-x.gihub.io/) to learn more. # Credits diff --git a/examples/grpcbin/README.md b/examples/grpcbin/README.md index f2597f920..2db25de51 100644 --- a/examples/grpcbin/README.md +++ b/examples/grpcbin/README.md @@ -13,7 +13,7 @@ This directory contains: └── grpcbin.yaml # opta service file **NOTE**: Typically, the first step of the example would be to demonstrate how one may deploy the application locally -but currently GRPC with opta does not function locally, and requires [TLS set up](https://docs.opta.dev/tutorials/ingress/#setting-the-domain-for-an-environment-via-domain-delegation) +but currently GRPC with opta does not function locally, and requires [TLS set up](http://run-x.gihub.io/tutorials/ingress/#setting-the-domain-for-an-environment-via-domain-delegation) in the cloud environments to function. If you have pressing need for this feature, please let us know in our [slack channel](https://slack.opta.dev) @@ -33,7 +33,7 @@ in the cloud environments to function. If you have pressing need for this featur # when done, find load_balancer_raw_dns or load_balancer_raw_ip in the output and save it export load_balancer=[Value from output] ``` -3. Complete the [TLS and domain set up](https://docs.opta.dev/tutorials/ingress/#setting-the-domain-for-an-environment-via-domain-delegation) +3. Complete the [TLS and domain set up](http://run-x.gihub.io/tutorials/ingress/#setting-the-domain-for-an-environment-via-domain-delegation) 4. Deploy the service: push the image and deploy it to Kubernetes ```bash opta apply --config grpcbin.yaml --auto-approve --env $ENV diff --git a/examples/minecraft/README.md b/examples/minecraft/README.md index 99ab3c96b..f73f87e01 100644 --- a/examples/minecraft/README.md +++ b/examples/minecraft/README.md @@ -37,7 +37,7 @@ this by modifying the `env_vars` field of the k8s-service module of the deployme # Multiple Minecraft Servers If you wish to host multiple minecraft servers/worlds in the same environment, do the following steps: -* Create a new [Opta Service](https://docs.opta.dev/getting-started/aws/#service-creation) yaml manifest holding a new +* Create a new [Opta Service](http://run-x.gihub.io/getting-started/aws/#service-creation) yaml manifest holding a new k8s-service module instance under the modules list (**WARNING**: this is needed because Opta currently only allows one k8s service per yaml manifest). * In your new service manifest, update the `service_port` field set to 25565 to a new value (typically just increment @@ -105,7 +105,7 @@ name_servers = tolist([ * Your minecraft server should now be accessible under your domain-- go ahead and update your minecraft client config to point to this new domain instead of the load balancer directly. -For more information, checkout this [this tutorial](https://docs.opta.dev/tutorials/ingress/) and follow the dns +For more information, checkout this [this tutorial](http://run-x.gihub.io/tutorials/ingress/) and follow the dns delegation steps. # [FAQ](../FAQ.md) diff --git a/examples/nocodb/nocodb-aws.yaml b/examples/nocodb/nocodb-aws.yaml index 4ce8d0bf1..c7a35c280 100644 --- a/examples/nocodb/nocodb-aws.yaml +++ b/examples/nocodb/nocodb-aws.yaml @@ -8,7 +8,7 @@ modules: - type: base - type: dns domain: > - delegated: false # set to true once ready https://docs.opta.dev/miscellaneous/ingress/ + delegated: false # set to true once ready http://run-x.gihub.io/miscellaneous/ingress/ - type: k8s-cluster - type: k8s-base name: k8sbase diff --git a/examples/opta-mern-stack/README.md b/examples/opta-mern-stack/README.md index b4d97d3e6..4e7b87728 100644 --- a/examples/opta-mern-stack/README.md +++ b/examples/opta-mern-stack/README.md @@ -1,7 +1,7 @@ ![alt text](MERN.jpg "MERN Stack MongoDB, Express, React, Node.js") ## Introduction -MERN stack is a web software stack that includes MongoDB, Express.js, React, and Node.js. In this post we show how you can use [Opta](https://docs.opta.dev/) to easily stand up a MERN-based application stack on a public cloud (aws) or Local development Kubernetes cluster. Specifically: +MERN stack is a web software stack that includes MongoDB, Express.js, React, and Node.js. In this post we show how you can use [Opta](http://run-x.gihub.io/) to easily stand up a MERN-based application stack on a public cloud (aws) or Local development Kubernetes cluster. Specifically: 1. An [AWS eks/Local PC Kind] Kubernetes cluster built to SOC2 security standards @@ -14,7 +14,7 @@ MERN stack is a web software stack that includes MongoDB, Express.js, React, and ## Pre-requisites -Opta is a new kind of Infrastructure-As-Code framework where you work with high-level constructs instead of getting lost in low level cloud configuration or having to deal with [Terraform HCL](https://blog.runx.dev/my-pet-peeves-with-terraform-f9bb37d94950). You can install Opta on your PC by following the instructions [here](https://docs.opta.dev/installation/). +Opta is a new kind of Infrastructure-As-Code framework where you work with high-level constructs instead of getting lost in low level cloud configuration or having to deal with [Terraform HCL](https://blog.runx.dev/my-pet-peeves-with-terraform-f9bb37d94950). You can install Opta on your PC by following the instructions [here](http://run-x.gihub.io/installation/). Our MERN stack example is based on the application code created by The MongoDB Atlas team. Their [blog post](https://www.mongodb.com/languages/mern-stack-tutorial) will walk you through the Nodejs+Express backend, React frontend and MongoDB code. You should take a moment to read the blog post, although keep in mind that most of the manual/click-on-GUI steps mentioned in the post to setup the infrastructure are not applicable to this Opta Infrastructure-as-code MERN stack example. @@ -22,9 +22,9 @@ You can choose to deploy the MERN stack application on Kubernetes running in AWS 1. Clone the [Opta repo](https://github.com/run-x/opta); the MERN stack example is located in the `opta-mern-stack` sub-directory of the examples directory of this repository. -2. Install Opta, as mentioned above, using [these instructions](https://docs.opta.dev/installation/). +2. Install Opta, as mentioned above, using [these instructions](http://run-x.gihub.io/installation/). 3. Make a MongoDB Atlas account and obtain their [API credentials](https://docs.atlas.mongodb.com/tutorial/manage-programmatic-access?utm_source=runx_opta&utm_campaign=pla&utm_medium=referral); you will need these in your terminal environment to allow Opta to spin up a MongoDB cluster for your application. -4. If you don't already have your cloud credentials (AWS), you can follow the Opta instructions for [AWS](https://docs.opta.dev/getting-started/aws/). If you plan on deploying with Opta [locally](https://docs.opta.dev/getting-started/local/) on your PC, this step is not needed. +4. If you don't already have your cloud credentials (AWS), you can follow the Opta instructions for [AWS](http://run-x.gihub.io/getting-started/aws/). If you plan on deploying with Opta [locally](http://run-x.gihub.io/getting-started/local/) on your PC, this step is not needed. So as an example, for AWS, you will inject the API keys into your terminal environment where opta will be invoked like so @@ -90,7 +90,7 @@ Click on the top left "MongoDB" image to see the list of records. ![alt text](mern-record-list.png "MERN Stack React SPA Record List") -As a side note, you can always configure DNS and TLS certificates using Opta for your your production application, as explained [here](https://docs.opta.dev/tutorials/ingress/). +As a side note, you can always configure DNS and TLS certificates using Opta for your your production application, as explained [here](http://run-x.gihub.io/tutorials/ingress/). ## Teardown @@ -111,4 +111,4 @@ opta deestroy --local-c opta/examples/opta-mern-stack/client/opta-frontend-serve Take a moment to think of just how much you have built and deployed with a modest amount of effort: a production-grade Kubernetes cluster and MongoDB Atlas database in the cloud supporting a containerized MERN stack scalable application! From local laptop development to a production-grade public cloud Kubernetes deployment, Opta walks alongside you in your development and scaling journey. -__Credits: The application frontend and backend is largely derived from the [MERN stack tutorial](https://www.mongodb.com/languages/mern-stack-tutorial) by the folks at Mongodb.com. The MERN stack picture is from https://wikitia.com/wiki/File:MERN.jpg__ \ No newline at end of file +__Credits: The application frontend and backend is largely derived from the [MERN stack tutorial](https://www.mongodb.com/languages/mern-stack-tutorial) by the folks at Mongodb.com. The MERN stack picture is from https://wikitia.com/wiki/File:MERN.jpg__ diff --git a/modules/aws_k8s_service/aws-k8s-service.json b/modules/aws_k8s_service/aws-k8s-service.json index cbcd7aed2..37cfe3823 100644 --- a/modules/aws_k8s_service/aws-k8s-service.json +++ b/modules/aws_k8s_service/aws-k8s-service.json @@ -33,7 +33,7 @@ }, "healthcheck_command": { "type": "array", - "description": "See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks)", + "description": "See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks)", "default": [] }, "liveness_probe_command": { @@ -92,14 +92,14 @@ }, "autoscaling_target_cpu_percentage": { "type": "integer", - "description": "See the [autoscaling](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#autoscaling) section.", + "description": "See the [autoscaling](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#autoscaling) section.", "default": 80, "minimum": 0, "maximum": 100 }, "autoscaling_target_mem_percentage": { "type": "integer", - "description": "See the [autoscaling](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#autoscaling) section.", + "description": "See the [autoscaling](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#autoscaling) section.", "default": 80, "minimum": 0, "maximum": 100 @@ -119,7 +119,7 @@ }, "healthcheck_path": { "type": "string", - "description": "See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks)" + "description": "See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks)" }, "liveness_probe_path": { "type": "string", @@ -154,7 +154,7 @@ "default": 86400 }, "resource_request": { - "description": "See the [container resources](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#resource-requests) section.\nCPU is given in millicores, and Memory is in megabytes.\n", + "description": "See the [container resources](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#resource-requests) section.\nCPU is given in millicores, and Memory is in megabytes.\n", "type": "object", "properties": { "cpu": { @@ -262,4 +262,4 @@ "type" ], "type": "object" -} \ No newline at end of file +} diff --git a/modules/aws_k8s_service/aws-k8s-service.yaml b/modules/aws_k8s_service/aws-k8s-service.yaml index f8331b18f..5106510d2 100644 --- a/modules/aws_k8s_service/aws-k8s-service.yaml +++ b/modules/aws_k8s_service/aws-k8s-service.yaml @@ -76,12 +76,12 @@ inputs: - name: autoscaling_target_cpu_percentage user_facing: true validator: any(str(), int(), required=False) - description: See the [autoscaling](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#autoscaling) section. + description: See the [autoscaling](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#autoscaling) section. default: 80 - name: autoscaling_target_mem_percentage user_facing: true validator: any(str(), int(), required=False) - description: See the [autoscaling](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#autoscaling) section. + description: See the [autoscaling](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#autoscaling) section. default: 80 - name: secrets user_facing: true @@ -101,12 +101,12 @@ inputs: - name: healthcheck_path user_facing: true validator: str(required=False) - description: See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks) + description: See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks) default: null - name: healthcheck_command user_facing: true validator: list(str(), required=False) - description: See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks) + description: See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks) default: [] - name: liveness_probe_command user_facing: true @@ -157,7 +157,7 @@ inputs: user_facing: true validator: any(include('resources'), required=False) description: | - See the [container resources](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#resource-requests) section. + See the [container resources](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#resource-requests) section. CPU is given in millicores, and Memory is in megabytes. default: cpu: 100 diff --git a/modules/azure_k8s_service/azure-k8s-service.json b/modules/azure_k8s_service/azure-k8s-service.json index f565ac8d9..a69526483 100644 --- a/modules/azure_k8s_service/azure-k8s-service.json +++ b/modules/azure_k8s_service/azure-k8s-service.json @@ -43,7 +43,7 @@ }, "healthcheck_command": { "type": "array", - "description": "See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks)", + "description": "See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks)", "default": [] }, "liveness_probe_command": { @@ -68,14 +68,14 @@ }, "autoscaling_target_cpu_percentage": { "type": "integer", - "description": "See the [autoscaling](https://docs.opta.dev/reference/azurerm/modules/azure-k8s-service/#autoscaling) section.", + "description": "See the [autoscaling](http://run-x.gihub.io/reference/azurerm/modules/azure-k8s-service/#autoscaling) section.", "default": 80, "minimum": 0, "maximum": 100 }, "autoscaling_target_mem_percentage": { "type": "integer", - "description": "See the [autoscaling](https://docs.opta.dev/reference/azurerm/modules/azure-k8s-service/#autoscaling) section.", + "description": "See the [autoscaling](http://run-x.gihub.io/reference/azurerm/modules/azure-k8s-service/#autoscaling) section.", "default": 80, "minimum": 0, "maximum": 100 @@ -95,7 +95,7 @@ }, "healthcheck_path": { "type": "string", - "description": "See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks)" + "description": "See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks)" }, "liveness_probe_path": { "type": "string", @@ -130,7 +130,7 @@ "default": 86400 }, "resource_request": { - "description": "See the [container resources](https://docs.opta.dev/reference/azurerm/modules/azure-k8s-service/#container-resources) section.\nCPU is given in millicores, and Memory is in megabytes.\n", + "description": "See the [container resources](http://run-x.gihub.io/reference/azurerm/modules/azure-k8s-service/#container-resources) section.\nCPU is given in millicores, and Memory is in megabytes.\n", "type": "object", "properties": { "cpu": { @@ -238,4 +238,4 @@ "type" ], "type": "object" -} \ No newline at end of file +} diff --git a/modules/azure_k8s_service/azure-k8s-service.yaml b/modules/azure_k8s_service/azure-k8s-service.yaml index 0967eaee8..a01dd6b49 100644 --- a/modules/azure_k8s_service/azure-k8s-service.yaml +++ b/modules/azure_k8s_service/azure-k8s-service.yaml @@ -62,12 +62,12 @@ inputs: # (what users see) - name: autoscaling_target_cpu_percentage user_facing: true validator: any(str(), int(), required=False) - description: See the [autoscaling](https://docs.opta.dev/reference/azurerm/modules/azure-k8s-service/#autoscaling) section. + description: See the [autoscaling](http://run-x.gihub.io/reference/azurerm/modules/azure-k8s-service/#autoscaling) section. default: 80 - name: autoscaling_target_mem_percentage user_facing: true validator: any(str(), int(), required=False) - description: See the [autoscaling](https://docs.opta.dev/reference/azurerm/modules/azure-k8s-service/#autoscaling) section. + description: See the [autoscaling](http://run-x.gihub.io/reference/azurerm/modules/azure-k8s-service/#autoscaling) section. default: 80 - name: secrets user_facing: true @@ -87,12 +87,12 @@ inputs: # (what users see) - name: healthcheck_path user_facing: true validator: str(required=False) - description: See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks) + description: See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks) default: null - name: healthcheck_command user_facing: true validator: list(str(), required=False) - description: See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks) + description: See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks) default: [] - name: liveness_probe_command user_facing: true @@ -143,7 +143,7 @@ inputs: # (what users see) user_facing: true validator: any(include('resources'), required=False) description: | - See the [container resources](https://docs.opta.dev/reference/azurerm/modules/azure-k8s-service/#container-resources) section. + See the [container resources](http://run-x.gihub.io/reference/azurerm/modules/azure-k8s-service/#container-resources) section. CPU is given in millicores, and Memory is in megabytes. default: cpu: 100 diff --git a/modules/cloudfront_distribution/tf_module/main.tf b/modules/cloudfront_distribution/tf_module/main.tf index 7e9f311cc..c390eefea 100644 --- a/modules/cloudfront_distribution/tf_module/main.tf +++ b/modules/cloudfront_distribution/tf_module/main.tf @@ -14,7 +14,7 @@ data "aws_lb" "ingress-nginx" { } -# This is optional, see Opta docs for this here: https://docs.opta.dev/reference/aws/modules/cloudfront-distribution/ +# This is optional, see Opta docs for this here: http://run-x.gihub.io/reference/aws/modules/cloudfront-distribution/ #tfsec:ignore:aws-cloudfront-enable-waf resource "aws_cloudfront_distribution" "distribution" { diff --git a/modules/gcp_k8s_service/gcp-k8s-service.json b/modules/gcp_k8s_service/gcp-k8s-service.json index 9db5863e2..ad1396dea 100644 --- a/modules/gcp_k8s_service/gcp-k8s-service.json +++ b/modules/gcp_k8s_service/gcp-k8s-service.json @@ -38,7 +38,7 @@ }, "healthcheck_command": { "type": "array", - "description": "See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks)", + "description": "See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks)", "default": [] }, "liveness_probe_command": { @@ -77,14 +77,14 @@ }, "autoscaling_target_cpu_percentage": { "type": "integer", - "description": "See the [autoscaling](https://docs.opta.dev/reference/google/modules/gcp-k8s-service/#autoscaling) section.", + "description": "See the [autoscaling](http://run-x.gihub.io/reference/google/modules/gcp-k8s-service/#autoscaling) section.", "default": 80, "minimum": 0, "maximum": 100 }, "autoscaling_target_mem_percentage": { "type": "integer", - "description": "See the [autoscaling](https://docs.opta.dev/reference/google/modules/gcp-k8s-service/#autoscaling) section.", + "description": "See the [autoscaling](http://run-x.gihub.io/reference/google/modules/gcp-k8s-service/#autoscaling) section.", "default": 80, "minimum": 0, "maximum": 100 @@ -104,7 +104,7 @@ }, "healthcheck_path": { "type": "string", - "description": "See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks)" + "description": "See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks)" }, "liveness_probe_path": { "type": "string", @@ -139,7 +139,7 @@ "default": 86400 }, "resource_request": { - "description": "See the [container resources](https://docs.opta.dev/reference/google/modules/gcp-k8s-service/#container-resources) section.\nCPU is given in millicores, and Memory is in megabytes.\n", + "description": "See the [container resources](http://run-x.gihub.io/reference/google/modules/gcp-k8s-service/#container-resources) section.\nCPU is given in millicores, and Memory is in megabytes.\n", "type": "object", "properties": { "cpu": { @@ -251,4 +251,4 @@ "type" ], "type": "object" -} \ No newline at end of file +} diff --git a/modules/gcp_k8s_service/gcp-k8s-service.yaml b/modules/gcp_k8s_service/gcp-k8s-service.yaml index d5dc72bd0..b051b5f7b 100644 --- a/modules/gcp_k8s_service/gcp-k8s-service.yaml +++ b/modules/gcp_k8s_service/gcp-k8s-service.yaml @@ -66,12 +66,12 @@ inputs: - name: autoscaling_target_cpu_percentage user_facing: true validator: any(str(), int(), required=False) - description: See the [autoscaling](https://docs.opta.dev/reference/google/modules/gcp-k8s-service/#autoscaling) section. + description: See the [autoscaling](http://run-x.gihub.io/reference/google/modules/gcp-k8s-service/#autoscaling) section. default: 80 - name: autoscaling_target_mem_percentage user_facing: true validator: any(str(), int(), required=False) - description: See the [autoscaling](https://docs.opta.dev/reference/google/modules/gcp-k8s-service/#autoscaling) section. + description: See the [autoscaling](http://run-x.gihub.io/reference/google/modules/gcp-k8s-service/#autoscaling) section. default: 80 - name: secrets user_facing: true @@ -91,12 +91,12 @@ inputs: - name: healthcheck_path user_facing: true validator: str(required=False) - description: See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks) + description: See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `null` (i.e., no user-specified healthchecks) default: null - name: healthcheck_command user_facing: true validator: list(str(), required=False) - description: See the See the [healthcheck probe](https://docs.opta.dev/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks) + description: See the See the [healthcheck probe](http://run-x.gihub.io/reference/aws/modules/aws-k8s-service/#healthcheck-probe) section. Default `[]` (i.e., no user-specified healthchecks) default: [] - name: liveness_probe_command user_facing: true @@ -138,7 +138,7 @@ inputs: user_facing: true validator: any(include('resources'), required=False) description: | - See the [container resources](https://docs.opta.dev/reference/google/modules/gcp-k8s-service/#container-resources) section. + See the [container resources](http://run-x.gihub.io/reference/google/modules/gcp-k8s-service/#container-resources) section. CPU is given in millicores, and Memory is in megabytes. default: cpu: 100 diff --git a/opta/cli.py b/opta/cli.py index d0a2839bb..91417997b 100755 --- a/opta/cli.py +++ b/opta/cli.py @@ -39,7 +39,7 @@ def cli() -> None: Github: https://github.com/run-x/opta - Documentation: https://docs.opta.dev/ + Documentation: http://run-x.gihub.io/ """ pass diff --git a/opta/commands/deploy.py b/opta/commands/deploy.py index 1c0c8a8da..bbe28693f 100644 --- a/opta/commands/deploy.py +++ b/opta/commands/deploy.py @@ -74,7 +74,7 @@ def deploy( opta deploy -c my-service.yaml -i my-image:latest --local - Documentation: https://docs.opta.dev/features/custom_image/ + Documentation: http://run-x.gihub.io/features/custom_image/ """ @@ -92,7 +92,7 @@ def deploy( fmt_msg( """ Opta deploy can only run on service yaml files. This is an environment yaml file. - ~See https://docs.opta.dev/getting-started/ for more details. + ~See http://run-x.gihub.io/getting-started/ for more details. ~ ~(We think that this is an environment yaml file, because service yaml must ~specify the "environments" field). diff --git a/opta/commands/secret.py b/opta/commands/secret.py index 7de6a48ac..526ef0342 100644 --- a/opta/commands/secret.py +++ b/opta/commands/secret.py @@ -93,7 +93,7 @@ def secret() -> None: opta secret view -c my-service.yaml "MY_SECRET_1" - Documentation: https://docs.opta.dev/features/secrets/ + Documentation: http://run-x.gihub.io/features/secrets/ """ pass diff --git a/opta/commands/upgrade.py b/opta/commands/upgrade.py index f6793475c..2d8be69c5 100644 --- a/opta/commands/upgrade.py +++ b/opta/commands/upgrade.py @@ -48,7 +48,7 @@ def _upgrade() -> None: except Exception: logger.error( "\nUnable to install latest version of Opta." - "\nPlease follow the instructions on https://docs.opta.dev/installation" + "\nPlease follow the instructions on http://run-x.gihub.io/installation" ) finally: _cleanup_installation_file() diff --git a/opta/constants.py b/opta/constants.py index 3bc55e63e..5c717d6ab 100644 --- a/opta/constants.py +++ b/opta/constants.py @@ -57,7 +57,7 @@ REDS: Final = (1, 9, 124, 160, 196) -OPTA_INSTALL_URL: Final = "https://docs.opta.dev/install.sh" +OPTA_INSTALL_URL: Final = "http://run-x.gihub.io/install.sh" successfull_upgrade: Final = os.path.join( os.path.dirname(os.path.dirname(__file__)), ".successfull_upgrade" ) diff --git a/opta/core/terraform.py b/opta/core/terraform.py index ff8600a57..0017f22e9 100644 --- a/opta/core/terraform.py +++ b/opta/core/terraform.py @@ -119,7 +119,7 @@ def insert_extra_env(cls, layer: "Layer") -> dict: def validate_version(cls) -> None: ensure_installed("terraform") - pre_req_link = "Check https://docs.opta.dev/installation/#prerequisites" + pre_req_link = "Check http://run-x.gihub.io/installation/#prerequisites" current_version = Terraform.get_version() current_parsed = version.parse(current_version) diff --git a/opta/core/upgrade.py b/opta/core/upgrade.py index 04d74c03a..d69ad622d 100644 --- a/opta/core/upgrade.py +++ b/opta/core/upgrade.py @@ -13,7 +13,7 @@ os.environ.get("OPTA_UPGRADE_CHECK_PROBABILITY", "0.2") ) # TODO: Change this to the actual upgrade URL. -UPGRADE_INSTRUCTIONS_URL = "https://docs.opta.dev/installation/" +UPGRADE_INSTRUCTIONS_URL = "http://run-x.gihub.io/installation/" def _should_check_for_version_upgrade() -> bool: diff --git a/opta/layer.py b/opta/layer.py index c9254a111..de810db3a 100644 --- a/opta/layer.py +++ b/opta/layer.py @@ -804,7 +804,7 @@ def _validate_providers(providers: dict) -> None: if providers is None: raise UserErrors( "Environment Configuration needs a Provider Section.\n" - "Please follow `https://docs.opta.dev/getting-started/` to get started." + "Please follow `http://run-x.gihub.io/getting-started/` to get started." ) """ diff --git a/tests/core/test_terraform.py b/tests/core/test_terraform.py index b8b8603b0..b63cafff0 100644 --- a/tests/core/test_terraform.py +++ b/tests/core/test_terraform.py @@ -59,7 +59,7 @@ def test_validate_version_low(self, mocker: MockFixture) -> None: assert ( str(e.value) - == "Invalid terraform version 0.14.9 -- must be at least 0.15.0. Check https://docs.opta.dev/installation/#prerequisites" + == "Invalid terraform version 0.14.9 -- must be at least 0.15.0. Check http://run-x.gihub.io/installation/#prerequisites" ) get_version.assert_called_once() @@ -73,7 +73,7 @@ def test_validate_version_high(self, mocker: MockFixture) -> None: assert ( str(e.value) - == "Invalid terraform version 2.0.0 -- must be less than 2.0.0. Check https://docs.opta.dev/installation/#prerequisites" + == "Invalid terraform version 2.0.0 -- must be less than 2.0.0. Check http://run-x.gihub.io/installation/#prerequisites" ) get_version.assert_called_once()