Skip to content

Commit

Permalink
replace docs reference
Browse files Browse the repository at this point in the history
  • Loading branch information
NitinAgg committed Aug 4, 2022
1 parent ce5d57f commit 652347d
Show file tree
Hide file tree
Showing 31 changed files with 81 additions and 81 deletions.
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions .circleci/src/jobs/download-opta-version.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -21,4 +21,4 @@ steps:
- persist_to_workspace:
root: ~/
paths:
- .opta
- .opta
4 changes: 2 additions & 2 deletions .circleci/src/jobs/download-opta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -18,4 +18,4 @@ steps:
- persist_to_workspace:
root: ~/
paths:
- .opta
- .opta
2 changes: 1 addition & 1 deletion .github/workflows/update-latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Automated, secure, scalable cloud infrastructure</p>

</p>
<p align="center">
<a href="https://docs.opta.dev/">Documentation</a> |
<a href="http://run-x.gihub.io/">Documentation</a> |
<a href="https://slack.opta.dev">
Slack Community
</a> | <a href="mailto:info@runx.dev">
Expand Down Expand Up @@ -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)!


<p align="center">
Expand All @@ -67,32 +67,32 @@ 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
* CDN (Content Delivery Network)
* 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)


### Coexistence with existing infrastructure
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.

Expand Down
4 changes: 2 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions config/registry/aws/eks_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/byok-eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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?
Expand Down
2 changes: 1 addition & 1 deletion examples/flyte/flyte-aws.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ modules:
- type: base
- type: dns
domain: <<domain::string::The dns domain for your Flyte deployment>>
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
Expand Down
2 changes: 1 addition & 1 deletion examples/full-stack-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions examples/grpcbin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/minecraft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/nocodb/nocodb-aws.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ modules:
- type: base
- type: dns
domain: <domain::string::The dns domain for your NocoDB deployment>>
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
Expand Down
12 changes: 6 additions & 6 deletions examples/opta-mern-stack/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -14,17 +14,17 @@ 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.

You can choose to deploy the MERN stack application on Kubernetes running in AWS (EKS cluster) or Locally on your laptop ([Kind cluster](https://kind.sigs.k8s.io/docs/user/quick-start/)). AWS will incur cloud charges, but the local Kubernetes setup is completely free. We also use a MongoDB Atlas database, we will sign up for their service and use their a small database (could cost upto $3 per day); you can always scale up the MongoDB deployment for your production code later.


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

Expand Down Expand Up @@ -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

Expand All @@ -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__
__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__
Loading

0 comments on commit 652347d

Please sign in to comment.