Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge upstream #444

Merged
merged 15 commits into from
Aug 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cfignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ deploy/uaa/
docs/
build/dev_config.json
e2e-reports/
website/
3 changes: 2 additions & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ exclude_patterns:
- "**/vendor/"
- "**/*.d.ts"
- "**/__vendor/"
- "**/*_test.go"
- "**/*_test.go"
- "website/"
28 changes: 28 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: documentation

on:
pull_request:
branches: [master]
push:
branches: [master]

jobs:
build-docs:
if: github.event_name != 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '12.x'
- name: Test Build
run: |
cd website
if [ -e yarn.lock ]; then
yarn install --frozen-lockfile
elif [ -e package-lock.json ]; then
npm ci
else
npm i
fi
npm run build
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,7 @@ stratos-frontend-prebuild.zip
src/frontend/assets
src/frontend/sass
go-vendor-*.tgz

website/build
website/site-dist
website/.docusaurus
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Change Log

## 4.0.1

[Full Changelog](https://github.com/SUSE/stratos/compare/4.0.0...4.0.1)

This release contains a number of fixes and improvements:

**Improvements:**

- Helm Deployment: Allow nginx protocols and ciphers to be configured via values [\#4512](https://github.com/cloudfoundry/stratos/issues/4512)

**Fixes:**

- npm install can sometimes fail when symlinks from a previous Stratos version exist [\#4513](https://github.com/cloudfoundry/stratos/issues/4513)
- Helm Deployment: Default nginx ciphers are too restrictive [\#4503](https://github.com/cloudfoundry/stratos/issues/4503)



## 4.0.0

[Full Changelog](https://github.com/SUSE/stratos/compare/3.2.1...4.0.0)
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing to Stratos UI
# Contributing to Stratos

Stratos UI is an open project and welcomes contributions. These guidelines are provided to help you understand how the project works and to make contributing smooth and fun for everybody involved.
Stratos is an open project and welcomes contributions. These guidelines are provided to help you understand how the project works and to make contributing smooth and fun for everybody involved.

There are two main forms of contribution: reporting issues and performing code changes.

## Reporting Issues

If you find a problem with Stratos UI, report it using [GitHub issues](https://github.com/suse/stratos/issues/new).
If you find a problem with Stratos, report it using [GitHub issues](https://github.com/suse/stratos/issues/new).

Before reporting a new issue, please take a moment to check whether it has already been reported
[here](https://github.com/suse/stratos/issues). If this is the case, please:
Expand All @@ -29,7 +29,7 @@ This information will help to determine the cause and prepare a fix as fast as p
## Code Changes

Code contributions come in various forms and sizes, from simple bug fixes to implementation
of new features. Before making any non-trivial change, get in touch with the Stratos UI developers first. This can prevent wasted effort later.
of new features. Before making any non-trivial change, get in touch with the Stratos developers first. This can prevent wasted effort later.

To send your code change, use GitHub pull requests. The workflow is as follows:

Expand All @@ -43,7 +43,7 @@ To send your code change, use GitHub pull requests. The workflow is as follows:

1. Publish the branch and create a pull request.

1. Stratos UI developers will review your change and possibly point out issues.
1. Stratos developers will review your change and possibly point out issues.
Adapt the code under their guidance until all issues are resolved.

1. Finally, the pull request will get merged or rejected.
Expand Down
62 changes: 12 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,64 +9,26 @@

Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.

If you are looking for a version of Stratos, you can find ..
- V1 in the [v1-master](https://github.com/suse/stratos/tree/v1-master) branch.
- V2 in the [v2-master](https://github.com/suse/stratos/tree/v2-master) branch.
![Stratos Application view](website/static/images/screenshots/app-summary.png)

![Stratos Application view](docs/images/screenshots/app-summary.png)
Please visit our new [documentation site](https://stratos.app/). There you can discover

## Quick Start
1. Our [introduction](https://stratos.app/docs/), including quick start, contributing and troubleshooting guides.
1. How to [deploy](https://stratos.app/docs/deploy/overview) Stratos in a number of environments.
1. [Cloud Foundry](https://stratos.app/docs/deploy/cloud-foundry/cloud-foundry), as an application.
1. [Kubernetes](https://stratos.app/docs/deploy/kubernetes), using a Helm chart.
1. [Docker](https://stratos.app/docs/deploy/all-in-one), as a single container deploying all components.
1. Configuring advanced features such a [Single Sign On](https://stratos.app/docs/advanced/sso) and Cloud Foundry '[invite to org](https://stratos.app/docs/advanced/invite-user-guide)'.
1. Guides for [developers](https://stratos.app/docs/developer/introduction).
1. How to [extend](https://stratos.app/docs/extensions/introduction) Stratos [functionality](https://stratos.app/docs/extensions/frontend) and apply a custom [theme](https://stratos.app/docs/extensions/theming).

To get started quickly, we recommend following the steps to deploy the Stratos Console as a Cloud Foundry Application - see [here](deploy/cloud-foundry).

If you have [docker](https://www.docker.com/community-edition) installed, you can quickly deploy Stratos using the all-in-one container:
```
$ docker run -p 4443:443 splatform/stratos:latest
```

Once that has finished, you can then access Stratos by visiting https://localhost:4443.

## Deploying Stratos

Stratos can be deployed in the following environments:

1. Cloud Foundry, as an application. See [guide](deploy/cloud-foundry)
2. Kubernetes, using a Helm chart. See [guide](deploy/kubernetes)
3. Docker, single container deploying all components. See [guide](deploy/all-in-one)

## Troubleshooting

Please see our [Troubleshooting](docs/troubleshooting) page.

## Further Reading

Take a look at the [Feature Set](docs/features.md) for details on the feature set that Stratos provides.

Get an [Overview](docs/overview.md) of Stratos, its components and the different ways in which it can be deployed.

Take a look at the [Development Roadmap](docs/roadmap.md) to see where we are heading. We update our status page each week to summarize what we are working on - see the [Status Page](docs/status_updates.md).

Browse through features and issues in the project's [issues](https://github.com/suse/stratos/issues) page.

What kind of code is in Stratos? We've integrated [Code Climate](https://codeclimate.com) for some code quality and maintainability metrics. Take a stroll around the [project page](https://codeclimate.com/github/SUSE/stratos)

## Contributing

We very much welcome developers who would like to get involved and contribute to the development of the Stratos project. Please refer to the [Contributing guide](CONTRIBUTING.md) for more information.

For information to help getting started with development, please read the [Developer's Guide](docs/developers-guide.md).

## Support and feedback

We have a channel (#stratos) on the Cloud Foundy Slack where you can ask questions, get support or give us feedback. We'd love to hear from you if you are using Stratos.

You can join the Cloud Foundry Slack here - https://slack.cloudfoundry.org/ - and then join the #stratos channel.
> For more SUSE specific information, specifically regarding Stratos Kubernetes and Helm functionality, please see our `/docs` folder.

## Acknowledgements

Tested with Browserstack

<a href="https://www.browserstack.com"><img width="240px" src="docs/images/Browserstack-logo.svg" alt="Browserstack"></a>
<a href="https://www.browserstack.com"><img width="240px" src="website/static/images/Browserstack-logo.svg" alt="Browserstack"></a>

## License

Expand Down
18 changes: 11 additions & 7 deletions build/clean-symlinks.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const path = require('path');
const fs = require('fs');

// __dirname is the folder where build.js is located
const STRATOS_DIR= path.resolve(__dirname, '..');
const STRATOS_DIR = path.resolve(__dirname, '..');

function processFile(filepath) {
if (fs.existsSync(filepath)) {
Expand All @@ -23,14 +23,18 @@ function processFolder(dir) {
if (!fs.existsSync(dir)) {
return
}
fs.readdirSync(dir).forEach( f => {
fs.readdirSync(dir).forEach(f => {
let dirPath = path.join(dir, f);
const realPath = fs.realpathSync(dirPath);
const stats = fs.lstatSync(realPath);
if (stats.isDirectory()) {
processFolder(dirPath);
if (!fs.existsSync(dirPath)) {
fs.unlinkSync(dirPath);
} else {
processFile(dirPath);
const realPath = fs.realpathSync(dirPath);
const stats = fs.lstatSync(realPath);
if (stats.isDirectory()) {
processFolder(dirPath);
} else {
processFile(dirPath);
}
}
});
};
Expand Down
2 changes: 1 addition & 1 deletion deploy/Dockerfile.ui
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ RUN npm install && \
FROM splatform/stratos-nginx-base:leap15_1 as prod-build
RUN mkdir -p /usr/share/doc/suse
COPY deploy/containers/nginx/LICENSE.txt /usr/share/doc/suse/LICENSE.txt
COPY deploy/containers/nginx/conf/nginx.k8s.conf /etc/nginx/nginx.conf
COPY deploy/containers/nginx/conf/nginx.k8s.conf /etc/nginx/nginx.conf.tmpl
COPY --from=base-build /usr/dist /usr/share/nginx/html
COPY deploy/containers/nginx/run-nginx.sh/ /run-nginx.sh
EXPOSE 80 443
Expand Down
8 changes: 0 additions & 8 deletions deploy/README.md

This file was deleted.

Loading