{"id":20074199,"url":"https://github.com/juniper/contrail","last_synced_at":"2025-05-05T21:31:30.445Z","repository":{"id":29746994,"uuid":"113210558","full_name":"Juniper/contrail","owner":"Juniper","description":"Contrail repo for core components (go based)","archived":false,"fork":false,"pushed_at":"2024-02-14T19:12:03.000Z","size":90243,"stargazers_count":43,"open_issues_count":25,"forks_count":32,"subscribers_count":137,"default_branch":"master","last_synced_at":"2025-04-09T04:26:21.613Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Juniper.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-05T17:09:07.000Z","updated_at":"2025-02-08T14:14:32.000Z","dependencies_parsed_at":"2024-06-20T17:56:18.252Z","dependency_job_id":null,"html_url":"https://github.com/Juniper/contrail","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juniper%2Fcontrail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juniper%2Fcontrail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juniper%2Fcontrail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juniper%2Fcontrail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Juniper","download_url":"https://codeload.github.com/Juniper/contrail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252580025,"owners_count":21771252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T14:49:52.167Z","updated_at":"2025-05-05T21:31:25.433Z","avatar_url":"https://github.com/Juniper.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [POC] Go code base for Contrail projects\n\nThis repository holds Go implementation for Contrail projects.\nThe goal of this project is\nto realize Go-based implementation \u0026 etcd based such as Kubernetes\nin order to improve performance, scale and ease operation.\n\nWe are planning to add following sub components.\n\n- API Server (Python-based VNC API Server equivalent)\n- Sync (IF-MAP, RabbitMQ related code equivalent but depends on etcd)\n- Agent (SchemaTransformer, Device Manager equivalent)\n- Code generation tool (generateDS equivalent)\n\nCurrently, this project is\nPOC stage so any external/internal API or design subject to change up\nto community discussion.\n\n## Development setup\n\n### Step1. Install Go, Docker and Docker Compose\n\n- [Go](https://golang.org/doc/install)\n- [Docker](https://docs.docker.com/install/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\n### Step2. Go get Contrail\n\n```bash\ngo get -u github.com/Juniper/contrail\n```\n\nNote that `go get -u github.com/Juniper/contrail/cmd/contrailutil` fails because we don't\ncommit generated code.\n\n### Step3. Install dependencies\n\n```bash\n# move to repo\ncd $HOME/go/src/github.com/Juniper/contrail\n# make sure put GOBIN to path\nexport PATH=$PATH:$HOME/go/bin\n# or if you defined GOPATH\n# cd $GOPATH/src/github.com/Juniper/contrail\nmake deps\n```\n\n### Step4. Generate source code\n\n```bash\nmake generate\n```\n\n### Step5. Install Contrail binaries\n\n```bash\nmake install\n```\n\n### Step6. Setup test environment\n\n```bash\nmake testenv reset_db\n```\n\nNote that these commands use `docker` command and depending on your Docker configuration they may require root permissions.\nSee: [Docker Documentation](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user)\n\n## First run\n\n- Run Contrail process\n\n    ```bash\n    contrail -c sample/contrail.yml run\n    ```\n\n    Note that you can overwrite configuration parameters using environment variable with\n    prefix \"CONTRAIL_\"\n\n    For example CONTRAIL_DATABASE_DEBUG is overwriting database.debug value.\n\n    ```bash\n    CONTRAIL_DATABASE_DEBUG=true contrail -c sample/contrail.yml run\n    ```\n\n    Individual processes can be enabled or disabled using the configuration parameters.\n\n- Run CLI commands\n\n    ```bash\n    export CONTRAIL_CONFIG=sample/cli.yml\n\n    # Show schema\n    contrailcli schema virtual_network\n\n    # Sync resources\n    contrailcli sync sample/sample_resource.yml\n\n    # List resources\n    contrailcli list virtual_network --detail\n\n    # Delete resources\n    contrailcli delete sample/sample_resource.yml\n    ```\n\n    See: [CLI Usage](doc/cli.md)\n\n## Testing\n\nRun all tests with coverage:\n\n```bash\nmake test\n```\n\n## API documentation\n\nOpenAPI specification file is generated during every run of `make generate` and it is located in `./public/openapi.json`.\n\nYou can also run API doc server on local machine using:\n\n```bash\nmake apidoc\n```\n\nThe doc will be available on [localhost:5000](http://localhost:5000).\n\n## How to contribute\n\n- Follow [Openstack review process](https://docs.openstack.org/infra/manual/developers.html)\n- Use [Tungsten Fabric Gerrit](https://review.opencontrail.org)\n- Comply to [Code review guidelines](REVIEW.md)\n\n### Step1\n\nSetup Gerrit account. Sign CLA.\n\n### Step2\n\nInstall [git-review tool](https://docs.openstack.org/infra/git-review/installation.html).\n\n```bash\npip install git-review\n```\n\n### Step3\n\nSend review to Gerrit:\n\n```bash\ngit review\n```\n\n## Documentation\n\nSee: [Documentation index](./doc/index.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuniper%2Fcontrail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuniper%2Fcontrail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuniper%2Fcontrail/lists"}