diff --git a/README.md b/README.md index dafb275..ef5294a 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,42 @@ # Convox -[Convox](https://github.com/convox/convox) is an open-source PaaS based on Kubernetes available for multiple infrastructure providers. +Convox is an open-source [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service) based +on Kubernetes available for multiple cloud providers. -* Amazon Web Services -* Digital Ocean -* Google Cloud -* Microsoft Azure +## Supported Clouds + +- Amazon Web Services +- Digital Ocean +- Google Cloud +- Microsoft Azure + +## Getting Started + +- [Introduction](docs/getting-started/introduction.md) ## Installation -See the README in the [install](install) subdirectory for installation instructions. +* [Command Line Interface](docs/installation/cli.md) +* [Development Rack](docs/installation/development-rack) +* [Production Rack](docs/installation/production-rack) ## Features -* [Release Management](https://docs.convox.com/deployment/builds) -* [Secrets Management](https://docs.convox.com/application/environment) -* [Load Balancing](docs/guides/load-balancing.md) (automatic SSL) -* [Service Discovery](docs/guides/service-discovery.md) -* [Resource Management](https://docs.convox.com/use-cases/resources) \(Postgres, Redis, etc\) -* [Automated Rollbacks](https://docs.convox.com/deployment/rolling-back) -* [Autoscaling](https://docs.convox.com/deployment/scaling) -* [Scheduled Runs](https://docs.convox.com/application/timers) (cron) -* [One-off Commands](https://docs.convox.com/management/one-off-commands) +* [Release Management](docs/deployment/releases.md) +* [Secrets Management](docs/configuration/environment.md) +* [Load Balancing](docs/configuration/load-balancers.md) (automatic SSL) +* [Service Discovery](docs/configuration/service-discovery.md) +* [Resource Management](docs/reference/primitives/app/resource.md) (Postgres, Redis, etc) +* [Automated Rollbacks](docs/deployment/rollbacks.md) +* [Autoscaling](docs/deployment/scaling.md) +* [Scheduled Runs](docs/reference/primitives/app/timers.md) (cron) +* [One-off Commands](docs/management/run.md) ## Resources - [Homepage](https://convox.com) -- [Getting Started](https://docs.convox.com/introduction/getting-started) - [Community Forums](https://community.convox.com/) -- [FAQ](https://docs.convox.com/introduction/faq) ## License -[Apache 2.0](LICENSE) \ No newline at end of file +- [Apache 2.0](LICENSE) \ No newline at end of file diff --git a/docs/installation/production-rack/aws.md b/docs/installation/production-rack/aws.md index c630a06..34635ab 100644 --- a/docs/installation/production-rack/aws.md +++ b/docs/installation/production-rack/aws.md @@ -29,15 +29,12 @@ You can list all available regions for your account with the following command: ### Create IAM User $ aws iam create-user --user-name convox + $ aws iam attach-user-policy --user-name convox --policy-arn arn:aws:iam::aws:policy/AdministratorAccess $ aws iam create-access-key --user-name convox - `AWS_ACCESS_KEY_ID` is `AccessKeyId` - `AWS_SECRET_ACCESS_KEY` is `SecretAccessKey` -### Grant Permissions - - $ aws iam attach-user-policy --user-name convox --policy-arn arn:aws:iam::aws:policy/AdministratorAccess - ## Install Rack $ convox rack install aws diff --git a/docs/management/run.md b/docs/management/run.md new file mode 100644 index 0000000..88e752f --- /dev/null +++ b/docs/management/run.md @@ -0,0 +1 @@ +# One-off Commands diff --git a/docs/reference/primitives/app/timers.md b/docs/reference/primitives/app/timers.md new file mode 100644 index 0000000..e69de29 diff --git a/pkg/docs/docs.go b/pkg/docs/docs.go index 30e7f82..4c42aa0 100644 --- a/pkg/docs/docs.go +++ b/pkg/docs/docs.go @@ -25,6 +25,7 @@ var ( Category{"configuration", "Configuration"}, Category{"development", "Development"}, Category{"deployment", "Deployment"}, + Category{"management", "Management"}, Category{"reference", "Reference"}, Category{"integrations", "Integrations"}, Category{"help", "Help"},