X-Git-Url: https://gerrit.akraino.org/r/gitweb?a=blobdiff_plain;f=README.md;h=0a0199bf806410c597705ce472383f55d5de64d5;hb=7093adf2ba2a694de7f1435d87c4de8ae1f2fa28;hp=cf3756c439b0a7317643603e1516c36767da1a62;hpb=308b84a2851e9a16458e5aebfd9f0341ca7530bd;p=icn.git diff --git a/README.md b/README.md index cf3756c..0a0199b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,45 @@ -# Integrated Cloud Native +> NOTE: The ICN project is presently in the incubation/pre-production +> phase and is suitable for testing purposes only. -Work in progress +# Introduction -For more information refer - https://wiki.akraino.org/pages/viewpage.action?pageId=11995140 +ICN addresses the infrastructure orchestration needed to bring up a +site using baremetal servers. It strives to automate the process of +installing a jump server (Local Controller) to the greatest degree +possible – "zero touch installation". Once the jump server is booted +and the compute cluster-specific values are provided, the controller +begins to inspect and provision the baremetal servers until the +cluster is entirely configured. + +# Table of Contents +1. [Quick start](doc/quick-start.md) +2. [Installation guide](doc/installation-guide.md) +3. [Troubleshooting](doc/troubleshooting.md) +4. [Software BOM](doc/software-bom.md) + +# Reporting a bug + +Please report any issues found in the [ICN +JIRA](https://jira.akraino.org/projects/ICN/issues). A Linux +Foundation ID must be created first. + +# License +Apache license v2.0 + +``` +/* +* Copyright 2019-2022 Intel Corporation, Inc +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ +```