Skip to content
This repository has been archived by the owner on Jul 4, 2024. It is now read-only.

Commit

Permalink
Rename master branch to main (#1995)
Browse files Browse the repository at this point in the history
* Rename master branch to main

* Rename master to main in .md files, scripts and comments
  • Loading branch information
PetarTodorovv authored Sep 9, 2021
1 parent 26d523c commit 0640eb1
Show file tree
Hide file tree
Showing 26 changed files with 60 additions and 60 deletions.
2 changes: 1 addition & 1 deletion .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Thank you for your contribution. Before you submit the pull request:
1. Follow contributing guidelines, templates, the recommended Git workflow, and any related documentation.
2. Read and submit the required Contributor Licence Agreements (https://github.com/kyma-project/community/blob/master/CONTRIBUTING.md#agreements-and-licenses).
2. Read and submit the required Contributor Licence Agreements (https://github.com/kyma-project/community/blob/main/CONTRIBUTING.md#agreements-and-licenses).
3. Test your changes and attach their results to the pull request.
4. Update the relevant documentation.
-->
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of conduct

Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/master/CODE_OF_CONDUCT.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/main/CODE_OF_CONDUCT.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Overview

To contribute to this project, follow the rules from the general [CONTRIBUTING.md](https://github.com/kyma-project/community/blob/master/CONTRIBUTING.md) document in the `community` repository, located in the `kyma-project` organization.
To contribute to this project, follow the rules from the general [CONTRIBUTING.md](https://github.com/kyma-project/community/blob/main/CONTRIBUTING.md) document in the `community` repository, located in the `kyma-project` organization.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/kyma-incubator/compass/master/logo.png" width="235">
<img src="https://raw.githubusercontent.com/kyma-incubator/compass/main/logo.png" width="235">
</p>

## Overview
Expand All @@ -25,7 +25,7 @@ For more information about the Compass architecture, technical details, and comp

## Installation

Install Compass locally or on a cluster. See the [installation document](https://github.com/kyma-incubator/compass/blob/master/docs/compass/04-01-installation.md) for details.
Install Compass locally or on a cluster. See the [installation document](https://github.com/kyma-incubator/compass/blob/main/docs/compass/04-01-installation.md) for details.

### Dependencies

Expand Down
2 changes: 1 addition & 1 deletion chart/compass/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Compass is a multi-tenant system which consists of components that provide a way
- `gateway`
- `postgresql`

To learn more, read the [Compass documentation](https://github.com/kyma-incubator/compass/blob/master/README.md).
To learn more, read the [Compass documentation](https://github.com/kyma-incubator/compass/blob/main/README.md).
## Details

### Configuration
Expand Down
4 changes: 2 additions & 2 deletions components/connectivity-adapter/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Connectivity Adapter

Connectivity Adapter translates [Kyma Connector Service API](https://kyma-project.io/docs/master/components/application-connector/specifications/connectorapi/)
and [Kyma Application Registry API](https://kyma-project.io/docs/master/components/application-connector/specifications/metadataapi/)
Connectivity Adapter translates [Kyma Connector Service API](https://kyma-project.io/docs/main/components/application-connector/specifications/connectorapi/)
and [Kyma Application Registry API](https://kyma-project.io/docs/main/components/application-connector/specifications/metadataapi/)
to Compass Director and Compass Connnector GraphQL API.

## Development
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
Copied from https://github.com/kyma-project/kyma/tree/master/components/application-registry
Copied from https://github.com/kyma-project/kyma/tree/main/components/application-registry
*/
package validation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
Copied from https://github.com/kyma-project/kyma/tree/master/components/application-registry
Copied from https://github.com/kyma-project/kyma/tree/main/components/application-registry
*/
package validation

Expand Down
2 changes: 1 addition & 1 deletion components/connectivity-adapter/pkg/apperrors/apperrors.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
Copied from https://github.com/kyma-project/kyma/tree/master/components/application-registry
Copied from https://github.com/kyma-project/kyma/tree/main/components/application-registry
*/
package apperrors

Expand Down
2 changes: 1 addition & 1 deletion components/connectivity-adapter/pkg/res/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func WriteErrorMessage(writer http.ResponseWriter, errMessage string, appErrorCo
}

/**
Copied from https://github.com/kyma-project/kyma/tree/master/components/application-registry
Copied from https://github.com/kyma-project/kyma/tree/main/components/application-registry
*/

func errorCodeToHTTPStatus(code int) int {
Expand Down
2 changes: 1 addition & 1 deletion components/director/cmd/tenantfetcher-job/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This application fetches events containing information about created, updated, a

Tenant Fetcher requires access to:
1. Configured PostgreSQL database with the imported Director's database schema.
2. API that can be called to fetch tenant events. For details about implementing the Tenant Events API that the Tenant Fetcher can consume, see [this](https://github.com/kyma-incubator/compass/blob/master/components/director/internal/tenantfetcher/README.md) document.
2. API that can be called to fetch tenant events. For details about implementing the Tenant Events API that the Tenant Fetcher can consume, see [this](https://github.com/kyma-incubator/compass/blob/main/components/director/internal/tenantfetcher/README.md) document.

## Configuration

Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The directory has the following structure:

Follow these basic rules when you add a new document to the official documentation:

1. Get familiar with the [Content Strategy](https://github.com/kyma-project/community/blob/master/guidelines/content-guidelines/01-content-strategy.md) to learn about the official approach to content development.
2. Follow the [Contribution Guide](https://github.com/kyma-project/community/blob/master/contributing/02-contributing.md) for the general contribution rules and process.
3. Make use of the [templates](https://github.com/kyma-project/community/tree/master/guidelines/templates) to structure your documents properly.
4. Be compliant with the writing [guidelines](https://github.com/kyma-project/community/blob/master/guidelines/content-guidelines) to contribute high-quality and standardized content.
1. Get familiar with the [Content Strategy]https://github.com/kyma-project/community/blob/main/guidelines/content-guidelines/01-content-strategy.md) to learn about the official approach to content development.
2. Follow the [Contribution Guide](https://github.com/kyma-project/community/blob/main/contributing/02-contributing.md) for the general contribution rules and process.
3. Make use of the [templates](https://github.com/kyma-project/community/tree/main/guidelines/templates) to structure your documents properly.
4. Be compliant with the writing [guidelines](https://github.com/kyma-project/community/blob/main/guidelines/content-guidelines) to contribute high-quality and standardized content.
2 changes: 1 addition & 1 deletion docs/compass/02-01-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Runtime is a system to which you can apply configuration provided by Compass. Yo

Runtime Agent is an integral part of every Runtime and it fetches the latest configuration from Compass. It also provides Runtime specific information that is displayed in the Compass UI, such as Runtime UI URL, and it provides Compass with Runtime configuration, such as Event Gateway URL, that should be passed to an Application. In the future releases, Runtime Agent will send Runtime health checks to Compass.

An example of Runtime Agent implementation is the [Kyma Compass Runtime Agent](https://github.com/kyma-project/kyma/tree/master/components/compass-runtime-agent).
An example of Runtime Agent implementation is the [Kyma Compass Runtime Agent](https://github.com/kyma-project/kyma/tree/main/components/compass-runtime-agent).

## Cockpit

Expand Down
2 changes: 1 addition & 1 deletion docs/compass/03-01-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Each authentication flow is handled on a separate host via different VirtualServ

**Used by:** Integration System / Application / Runtime

There are two ways of creating a `client_id` and `client_secret` pair in the Hydra, using Hydra's [oauth client](https://github.com/kyma-project/kyma/blob/ab3d8878d013f8cc34c3f549dfa2f50f06502f14/docs/security/03-06-oauth2-server.md#register-an-oauth2-client) or [simple POST request](https://github.com/kyma-incubator/examples/tree/master/ory-hydra/scenarios/client-credentials#setup-an-oauth2-client).
There are two ways of creating a `client_id` and `client_secret` pair in the Hydra, using Hydra's [oauth client](https://github.com/kyma-project/kyma/blob/ab3d8878d013f8cc34c3f549dfa2f50f06502f14/docs/security/03-06-oauth2-server.md#register-an-oauth2-client) or [simple POST request](https://github.com/kyma-incubator/examples/tree/main/ory-hydra/scenarios/client-credentials#setup-an-oauth2-client).

**Obtaining token:**

Expand Down
2 changes: 1 addition & 1 deletion docs/compass/03-02-labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type Mutation {
}
```

> **TIP:** For all the GraphQL query and mutation examples that you can use, go to [this](https://github.com/kyma-incubator/compass/tree/master/components/director/examples) directory.
> **TIP:** For all the GraphQL query and mutation examples that you can use, go to [this](https://github.com/kyma-incubator/compass/tree/main/components/director/examples) directory.

LabelDefinition key has to be unique for a given tenant. You can provide only one value for a given label. However, this label can contain many elements, depending on the LabelDefinition schema. In the following example, the type of the label value is `Any`, which means that the value can be of any type, such as `JSON`, `string`, `int` etc.:

Expand Down
2 changes: 1 addition & 1 deletion docs/compass/03-tenant-loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are three default tenants predefined for Compass:
- `foo`
- `bar`

The list of default tenants is specified in the **global.tenants** parameter in the [`values.yaml`](https://github.com/kyma-incubator/compass/blob/master/chart/compass/values.yaml) file. You can modify this list by providing appropriate overrides.
The list of default tenants is specified in the **global.tenants** parameter in the [`values.yaml`](https://github.com/kyma-incubator/compass/blob/main/chart/compass/values.yaml) file. You can modify this list by providing appropriate overrides.

The `compass-director-tenant-loader-default` job that loads the list of default tenants is executed only once after the installation of the Compass chart. It is enabled by default. To disable it, set **global.tenantConfig.useDefaultTenants** to `false`.

Expand Down
12 changes: 6 additions & 6 deletions docs/compass/04-01-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ To install Compass as central Management Plane on a cluster, follow these steps:
| Installation option | Value to use with the installation command | Example value |
|------------------------- |------------------- |------------------------- |
| From the Compass `master` branch | `master` | `master` |
| From a specific commit on the Compass `master` branch | `master-{COMMIT_HASH}` | `master-34edf09a` |
| From the Compass `main` branch | `main` | `main` |
| From a specific commit on the Compass `main` branch | `main-{COMMIT_HASH}` | `main-34edf09a` |
| From a specific PR on the Compass repository | `PR-{PR_NUMBER}` | `PR-1420` |

The Kyma version is read from the [`KYMA_VERSION`](../../installation/resources/KYMA_VERSION) file on a specific commit.
Expand Down Expand Up @@ -157,7 +157,7 @@ To install Compass as central Management Plane on a cluster, follow these steps:

### Local Minikube installation

For local development, install Compass with the minimal Kyma installation on Minikube from the `master` branch. To do so, run this script:
For local development, install Compass with the minimal Kyma installation on Minikube from the `main` branch. To do so, run this script:

```bash
./installation/cmd/run.sh
Expand All @@ -182,7 +182,7 @@ You can install Compass on a single cluster with all Kyma components, including

To install Compass and Runtime components on a single cluster, follow these steps:

1. [Install Kyma with the Runtime Agent](https://kyma-project.io/docs/master/components/runtime-agent#installation-installation).
1. [Install Kyma with the Runtime Agent](https://kyma-project.io/docs/main/components/runtime-agent#installation-installation).
1. Apply the required overrides using the following command:

```bash
Expand Down Expand Up @@ -219,8 +219,8 @@ To install Compass and Runtime components on a single cluster, follow these step

| Installation option | Value to use with the installation command | Example value |
|------------------------- |------------------- |------------------------- |
| From the `master` branch | `master` | `master` |
| From a specific commit on the `master` branch | `master-{COMMIT_HASH}` | `master-34edf09a` |
| From the `main` branch | `main` | `main` |
| From a specific commit on the `main` branch | `main-{COMMIT_HASH}` | `main-34edf09a` |
| From a specific PR | `PR-{PR_NUMBER}` | `PR-1420` |

Once you decide on the installation option, use these commands:
Expand Down
2 changes: 1 addition & 1 deletion docs/director/03-01-hide-applications-from-runtimes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ It is possible to configure Compass so that it doesn't return Applications label

## Configuration

To configure the list of selectors used to filter the list of returned Applications, modify the **applicationHideSelectors** parameter in the [`values.yaml`](https://github.com/kyma-incubator/compass/blob/master/chart/compass/charts/director/values.yaml) file. You can modify this list by providing appropriate overrides.
To configure the list of selectors used to filter the list of returned Applications, modify the **applicationHideSelectors** parameter in the [`values.yaml`](https://github.com/kyma-incubator/compass/blob/main/chart/compass/charts/director/values.yaml) file. You can modify this list by providing appropriate overrides.

The **applicationHideSelectors** parameter is a multiline string with a map that contains the lists of **strings**. Map keys represent label keys, and strings represent label values that are used to filter the returned Applications.

Expand Down
22 changes: 11 additions & 11 deletions docs/director/03-tenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Compass Director is a multi-tenant service, which means that a single instance o

## Tenancy in Director
Director manages the configuration of the following main objects:
* [Application](https://github.com/kyma-incubator/compass/blob/master/docs/compass/02-01-components.md#application)
* [Runtime](https://github.com/kyma-incubator/compass/blob/master/docs/compass/02-01-components.md#kyma-runtime)
* [LabelDefinition](https://github.com/kyma-incubator/compass/blob/master/docs/compass/03-02-labels.md#labeldefinitions)
* [Automatic Scenario Assigment](https://github.com/kyma-incubator/compass/blob/master/docs/compass/03-03-automatic-scenario-assignment.md)
* [Integration System](https://github.com/kyma-incubator/compass/blob/master/docs/compass/02-01-components.md#integration-system)
* [ApplicationTemplate](https://github.com/kyma-incubator/compass/blob/master/docs/compass/02-01-components.md#applicationtemplate)
* [Application](https://github.com/kyma-incubator/compass/blob/main/docs/compass/02-01-components.md#application)
* [Runtime](https://github.com/kyma-incubator/compass/blob/main/docs/compass/02-01-components.md#kyma-runtime)
* [LabelDefinition](https://github.com/kyma-incubator/compass/blob/main/docs/compass/03-02-labels.md#labeldefinitions)
* [Automatic Scenario Assigment](https://github.com/kyma-incubator/compass/blob/main/docs/compass/03-03-automatic-scenario-assignment.md)
* [Integration System](https://github.com/kyma-incubator/compass/blob/main/docs/compass/02-01-components.md#integration-system)
* [ApplicationTemplate](https://github.com/kyma-incubator/compass/blob/main/docs/compass/02-01-components.md#applicationtemplate)

Applications, Runtimes, LabelDefinitions, and Automatic Scenario Assignments and their child resources, such as APIs, are bound to tenants.
Integration Systems and ApplicationTemplates are not bound to any tenant and can represent multiple tenants.
Expand All @@ -23,12 +23,12 @@ A tenant is mainly described by two properties:

Those properties are stored together with the metadata in the `business_tenant_mapping` table in the database.

The Compass Director GraphQL API exposes [tenants query](https://github.com/kyma-incubator/compass/blob/master/components/director/examples/query-tenants/query-tenants.graphql).
The Compass Director GraphQL API exposes [tenants query](https://github.com/kyma-incubator/compass/blob/main/components/director/examples/query-tenants/query-tenants.graphql).
The query returns a list of all tenants with their external identifier, internal identifier, and additional metadata.
## Creating tenants
You can create a tenant in Director manually by using the [SQL statement](https://github.com/kyma-incubator/compass/blob/master/components/schema-migrator/seeds/director/add_tenants.sql) or use one of the following importing mechanisms:
* [Tenant Loader](https://github.com/kyma-incubator/compass/tree/master/components/director/cmd/tenantloader) - a one-time job for importing tenants from files during the first Compass installation
* [Tenant Fetcher](https://github.com/kyma-incubator/compass/tree/master/components/director/cmd/tenantfetcher) - a periodic job that synchronizes tenants from an external system
You can create a tenant in Director manually by using the [SQL statement](https://github.com/kyma-incubator/compass/blob/main/components/schema-migrator/seeds/director/add_tenants.sql) or use one of the following importing mechanisms:
* [Tenant Loader](https://github.com/kyma-incubator/compass/tree/main/components/director/cmd/tenantloader) - a one-time job for importing tenants from files during the first Compass installation
* [Tenant Fetcher](https://github.com/kyma-incubator/compass/tree/main/components/director/cmd/tenantfetcher) - a periodic job that synchronizes tenants from an external system

## Authentication flow
Information about tenants is used during the authentication and authorization phase in Compass.
Expand All @@ -42,4 +42,4 @@ The tenant mapping flow looks as follows:

![](./assets/tenant-mapping.svg)

Having this information, Director can work as a multi-tenant service. For more information, refer to the document about [security in Compass](https://github.com/kyma-incubator/compass/blob/master/docs/compass/03-01-security.md).
Having this information, Director can work as a multi-tenant service. For more information, refer to the document about [security in Compass](https://github.com/kyma-incubator/compass/blob/main/docs/compass/03-01-security.md).
4 changes: 2 additions & 2 deletions docs/internal/proposals/separate-compass/separate-compass.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following section lists all steps needed to implement the Compass separation

- Define fixed Kyma release version in the Compass repo:

- Define the Kyma release version in the `installation/resources/KYMA_RELEASE` file. The file should only contain the version, for example `master-0a8b78da` or `PR-8679`.
- Define the Kyma release version in the `installation/resources/KYMA_RELEASE` file. The file should only contain the version, for example `main-0a8b78da` or `PR-8679`.

- Modify the Kyma Compass GKE Integration pipeline in the Kyma repository:

Expand Down Expand Up @@ -77,7 +77,7 @@ The following section lists all steps needed to implement the Compass separation

- Modify the API Gateway test:

- Make Gateway configurable for test API rules (currently there is [a hardcoded `kyma-gateway`](https://github.com/kyma-project/kyma/blob/master/tests/integration/api-gateway/gateway-tests/manifests/no_access_strategy.yaml#L11); this component is used by KEB).
- Make Gateway configurable for test API rules (currently there is [a hardcoded `kyma-gateway`](https://github.com/kyma-project/kyma/blob/main/tests/integration/api-gateway/gateway-tests/manifests/no_access_strategy.yaml#L11); this component is used by KEB).

- Modify pipelines for internal Compass environments.

Expand Down
Loading

0 comments on commit 0640eb1

Please sign in to comment.