You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
 
 
 
 
Karen Etheridge 49826ec593
Merge pull request #885 from joyent/ether/v3-collapse-validation_result-more
1 year ago
bin add list of conch commands to markdown doc 1 year ago
dev tighter whitespace config, and fixes 1 year ago
docker remove the bit that pushes docker images to hub.docker, and remove mention of it from the docs 1 year ago
docs move result_order to validation_state_result and drop it from response payloads 1 year ago
etc Provide infrastructure to build and test with Docker, including scripts for buildbot 1 year ago
json-schema move result_order to validation_state_result and drop it from response payloads 1 year ago
lib sort the validation results in this response too 1 year ago
misc allow processing one json-schema file on its own 1 year ago
report tighter whitespace config, and fixes 1 year ago
smf tighter whitespace config, and fixes 1 year ago
sql cascade deletes from validation_result -> validation_state_member 1 year ago
t move result_order to validation_state_result and drop it from response payloads 1 year ago
templates/email make workspaces and organizations aware of each other 1 year ago
.dockerignore the docker-compose file drops a "postgres" directory in the root. We dont want docker to try and pull that into images 1 year ago
.gitattributes tighter whitespace config, and fixes 1 year ago
.gitignore clean up .gitignore 1 year ago
.mailmap remap alternative email addresses 2 years ago
.perlcriticrc conch/Conch/* -> conch/* 2 years ago
.perltidyrc conch/Conch/* -> conch/* 2 years ago
CODEOWNERS fix precedence issue in codeowners 1 year ago
Dockerfile upgrade the dockerfiles to use postgres 10 which ships with ubuntu:bionic 1 year ago
Dockerfile.dev upgrade the dockerfiles to use postgres 10 which ships with ubuntu:bionic 1 year ago
LICENSE whitespace changes ONLY 1 year ago
Makefile ignore vim swap files 1 year ago
README.md remove the bit that pushes docker images to hub.docker, and remove mention of it from the docs 1 year ago
conch.conf.dist send rollbar message on error if configured request header matches 1 year ago
cpanfile refactor rollbar plugin exception handling, add more payload data, fix some bugs 1 year ago
cpanfile.snapshot refactor rollbar plugin exception handling, add more payload data, fix some bugs 1 year ago
docker-compose.yml tighter whitespace config, and fixes 1 year ago
schema-loader.yaml add many-to-many bridge accessors for join tables with extra columns 1 year ago

README.md

Conch API Server

Conch helps you build and manage datacenters.

Conch’s goal is to provide an end-to-end solution for full datacenter resource lifecycle: from design to initial power-on to end-of-life for all components of all devices.

Conch is open source, licensed under MPL2.

More documentation can be found here.

Caveat Emptor

The API is in a constant state of flux. Contact the development team before attempting to use it directly. The conch shell is our current stable interface.

Installation

Operating System Support

We currently support SmartOS 17.4 and Docker/Ubuntu. Being a Perl app, the API should run most anywhere but the code is only actively tested on SmartOS and Docker/Ubuntu.

Perl Support

The API is only certified to run against Perl 5.26.

Setup

Below is a list of useful Make commands that can be used to build and run the project. All of these should be run in the top level directory.

  • make run -- Build the project and run it
  • make test -- Run tests
  • make migrate-db -- Run database migrations

Needed Packages

Configuration

Copy conch.conf.dist to conch.conf, modifying for any local parameters, including database connectivity information.

Starting Conch

  • make run

Docker

Compose

The most simple way to get going with the Conch API is to use Docker Compose.

Build

First, build the image locally using docker/builder.sh

First Run

Copy conch.conf.dist to conch.conf, modifying for any local parameters. Specifically search for ‘docker’ in the comments. Ignore the database parameters.

# Edit compose file for desired release
docker-compose up -d postgres # initialize the postgres database
docker-compose run --rm web bin/conch-db all --username conch --email conch@example.com --password kaewee3hipheem8BaiHoo6waed7pha
docker-compose run --rm web bin/conch-db create-global-workspace
docker-compose up -d

Upgrading

docker-compose down
# Edit compose file for desired release
docker-compose pull
docker-compose up -d postgres
docker-compose run --rm web bin/conch-db migrate
docker-compose up -d

There may be extra commands to run, depending on the specific release. In that case, the upgrade will look something like:

docker-compose down
# Edit compose file for desired release
docker-compose pull
docker-compose up -d postgres
docker-compose run --rm web bin/conch-db migrate
docker-compose run --rm web bin/conch upgrade_release_225
docker-compose up -d

Licensing

Copyright Joyent, Inc.

This Source Code Form is subject to the terms of the Mozilla Public License, v.2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.