aro-rp

module
Version: v0.0.0-...-54afde0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2020 License: Apache-2.0

README

Azure Red Hat OpenShift Resource Provider

⚠️ Notice

For information relating to the generally available Azure Red Hat OpenShift v3 service, please see the following links:

Quickstarts

  • If you have a whitelisted subscription and want to use az aro to create a cluster using the production RP, follow using az aro.

  • If you want to deploy a development RP, follow deploy development RP.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Repository map

  • .github/workflows: CI workflows using GitHub Actions.

  • cmd/aro: RP entrypoint.

  • deploy: ARM templates to deploy RP in development and production.

  • docs: Documentation.

  • hack: Build scripts and utilities.

  • pkg: RP source code:

    • pkg/api: RP internal and external API definitions.

    • pkg/backend: RP backend workers.

    • pkg/client: Autogenerated ARO service Go client.

    • pkg/database: RP CosmosDB wrapper layer.

    • pkg/deploy: /deploy ARM template generation code.

    • pkg/env: RP environment-specific shims for running in production, development or test

    • pkg/frontend: RP frontend webserver.

    • pkg/install: OpenShift installer wrapper layer.

    • pkg/mirror: OpenShift release mirror tooling.

    • pkg/swagger: /swagger Swagger specification generation code.

    • pkg/util: Utility libraries.

  • python: Autogenerated ARO service Python client and az aro client extension.

  • swagger: Autogenerated ARO service Swagger specification.

  • test: End-to-end tests.

  • vendor: Vendored Go libraries.

Basic architecture

  • pkg/frontend is intended to become a spec-compliant RP web server. It is backed by CosmosDB. Incoming PUT/DELETE requests are written to the database with an non-terminal (Updating/Deleting) provisioningState.

  • pkg/backend reads documents with non-terminal provisioningStates, asynchronously updates them and finally updates document with a terminal provisioningState (Succeeded/Failed). The backend updates the document with a heartbeat - if this fails, the document will be picked up by a different worker.

  • As CosmosDB does not support document patch, care is taken to correctly pass through any fields in the internal model which the reader is unaware of (see github.com/ugorji/go/codec.MissingFielder). This is intended to help in upgrade cases and (in the future) with multiple microservices reading from the database in parallel.

  • Care is taken to correctly use optimistic concurrency to avoid document corruption through concurrent writes (see RetryOnPreconditionFailed).

  • The pkg/api architecture differs somewhat from github.com/openshift/openshift-azure: the intention is to fix the broken merge semantics and try pushing validation into the versioned APIs to improve error reporting.

  • Everything is intended to be crash/restart/upgrade-safe, horizontally scaleable, upgradeable...

Directories

Path Synopsis
cmd
aro
hack
db
pkg
api
client/services/preview/redhatopenshift/mgmt/2019-12-31-preview/redhatopenshift
Package redhatopenshift implements the Azure ARM Redhatopenshift service API version 2019-12-31-preview.
Package redhatopenshift implements the Azure ARM Redhatopenshift service API version 2019-12-31-preview.
deploy
Code generated for package deploy by go-bindata DO NOT EDIT.
Code generated for package deploy by go-bindata DO NOT EDIT.
env
util/mocks/azureclient/graphrbac
Package mock_graphrbac is a generated GoMock package.
Package mock_graphrbac is a generated GoMock package.
util/mocks/azureclient/keyvault
Package mock_keyvault is a generated GoMock package.
Package mock_keyvault is a generated GoMock package.
util/mocks/azureclient/mgmt/authorization
Package mock_authorization is a generated GoMock package.
Package mock_authorization is a generated GoMock package.
util/mocks/azureclient/mgmt/compute
Package mock_compute is a generated GoMock package.
Package mock_compute is a generated GoMock package.
util/mocks/azureclient/mgmt/containerregistry
Package mock_containerregistry is a generated GoMock package.
Package mock_containerregistry is a generated GoMock package.
util/mocks/azureclient/mgmt/dns
Package mock_dns is a generated GoMock package.
Package mock_dns is a generated GoMock package.
util/mocks/azureclient/mgmt/documentdb
Package mock_documentdb is a generated GoMock package.
Package mock_documentdb is a generated GoMock package.
util/mocks/azureclient/mgmt/keyvault
Package mock_keyvault is a generated GoMock package.
Package mock_keyvault is a generated GoMock package.
util/mocks/azureclient/mgmt/network
Package mock_network is a generated GoMock package.
Package mock_network is a generated GoMock package.
util/mocks/azureclient/mgmt/resources
Package mock_resources is a generated GoMock package.
Package mock_resources is a generated GoMock package.
util/mocks/azureclient/mgmt/storage
Package mock_storage is a generated GoMock package.
Package mock_storage is a generated GoMock package.
util/mocks/clusterdata
Package mock_clusterdata is a generated GoMock package.
Package mock_clusterdata is a generated GoMock package.
util/mocks/database
Package mock_database is a generated GoMock package.
Package mock_database is a generated GoMock package.
util/mocks/database/cosmosdb
Package mock_cosmosdb is a generated GoMock package.
Package mock_cosmosdb is a generated GoMock package.
util/mocks/instancemetadata
Package mock_instancemetadata is a generated GoMock package.
Package mock_instancemetadata is a generated GoMock package.
util/mocks/kubeactions
Package mock_kubeactions is a generated GoMock package.
Package mock_kubeactions is a generated GoMock package.
util/mocks/metrics
Package mock_metrics is a generated GoMock package.
Package mock_metrics is a generated GoMock package.
util/mocks/mock_azureclient/mgmt/mock_redhatopenshift
Package mock_redhatopenshift is a generated GoMock package.
Package mock_redhatopenshift is a generated GoMock package.
util/mocks/subnet
Package mock_subnet is a generated GoMock package.
Package mock_subnet is a generated GoMock package.
test
e2e

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL