Skip to content

Commit

Permalink
Cleanup (#6310)
Browse files Browse the repository at this point in the history
* Remove PagerDuty config + appveyor integration

* Updated deployment docs

* clean images

* Fix text

* PR comment
  • Loading branch information
skofman1 authored Aug 15, 2018
1 parent ac9e62d commit e5bc4fb
Show file tree
Hide file tree
Showing 12 changed files with 31 additions and 291 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[NuGet Gallery](http://nuget.org/) — Where packages are found
[NuGet Gallery](http://nuget.org/) — Where packages are found
=======================================================================

[![Build status](https://ci.appveyor.com/api/projects/status/6ob8lbutfecvi5n3/branch/master?svg=true)](https://ci.appveyor.com/project/NuGetteam/nugetgallery/branch/master)

This is an implementation of the NuGet Gallery and API. This serves as the back-end and community
website for the NuGet client. For information about the NuGet project, visit the [Home repository](https://github.com/nuget/home).

Expand Down Expand Up @@ -49,6 +47,10 @@ You can undo this with this command:
This should help prevent unwanted file commits.
## Deploy
You will find instructions on how to deploy the Gallery to Azure [here](https://github.com/NuGet/NuGetGallery/blob/master/docs/Deploying/README.md).
## Contribute
If you find a bug with the gallery, please visit the [Issue tracker](https://github.com/NuGet/NuGetGallery/issues) and
create an issue. If you're feeling generous, please search to see if the issue is already logged before creating a
Expand Down
8 changes: 0 additions & 8 deletions appveyor.yml

This file was deleted.

12 changes: 0 additions & 12 deletions docs/APIv3.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/Deploying/CloudServices/README.md

This file was deleted.

108 changes: 25 additions & 83 deletions docs/Deploying/README.md
Original file line number Diff line number Diff line change
@@ -1,119 +1,61 @@
# Deploying the NuGet Gallery

To run the NuGet Gallery you need to provision the following common resources:
To run the NuGet Gallery in Azure you need to provision the following resources:

1. An SQL Database to hold the package metadata.
1. A SQL Database to hold the package metadata.
2. A location in which to store package files. The Gallery supports two at the moment: Local File System and Azure Storage Account.
3. A Web Frontend to host the Gallery.
4. (Optional) A Worker Backend to perform offline processing tasks.

## Deploying to Azure

We suggest using Windows Azure for hosting the gallery, as that is the environment used by http://www.nuget.org itself. When doing so, we suggest using Azure SQL Databases (formerly SQL Azure) for the database and Azure Storage Accounts to store package files.
We suggest using Windows Azure for hosting the gallery, as that is the environment used by http://www.nuget.org itself. When doing so, we suggest using Azure SQL Databases for the database and Azure Storage Accounts to store package files.

We support two profiles of Azure deployment: [Azure Websites](Websites) and [Azure Cloud Services](CloudServices). Before using those guides, however, you need to ensure you provisiong the supporting resources (Database, Storage, etc.).
This guide will instruct you on hosting the Gallery to an Azure App Service. We will start with provisiong the supporting resources (Database, Storage, etc.).

## Provisioning for Azure

### Provisioning a Database

We recommend provisioning a dedicated Azure SQL Databases Server for the Gallery. If you are going to use our backend worker to generate statistics reports from data in a NuGet Warehouse, we recommend provisioning a separate Server for that database in production (the Warehouse may be co-located with the Gallery database if necessary though, and we do co-locate them in our non-production environments).
We recommend provisioning a dedicated Azure SQL Databases Server for the Gallery.

So, first create a database:

![Creating the Database](images/01-CreateDB.png)

Next, we need to create a user for the site to use. Open the **server** in the Azure Portal and click on the URL under `Manage URL`

![Manage URL](images/02-ManageUrl.png)

Type "master" in the database field and log in using the SA password for the server (which you should have copied down when you created the server ;)).

If you receive an error about firewall rules, go to the SQL Server entry in the Azure Portal, click the Configure tab and add your current client IP address to the list of allowed IP addresses (don't forget to click Save!). While here, double check that Allow Windows Azure Services is set to "YES".

Once logged in to the SQL management portal, create a new query and type the following (of course, replace 'some password here' with an actual, secure, password :)):

```SQL
CREATE LOGIN [nuget-site] WITH PASSWORD='some password here'
```

We use "nuget-site" as the name, but feel free to use any user name you want.

Now, log out and log in again, but this time, specify the name of the gallery database in the "Database" field (i.e. NuGetGallery). Then, create a new query and run these scripts (one at a time):

```SQL
CREATE USER [nuget-site] FROM LOGIN [nuget-site]
Follow the instrctions [here](https://docs.microsoft.com/en-us/azure/sql-database/sql-database-get-started-portal) to create an Azure SQL DB.
Copy the connection string from the portal. It should look something like:
```

```SQL
EXEC sp_addrolemember 'db_owner', 'nuget-site';
Server=[servername].database.windows.net;Database=NuGetGallery;User ID=[username];Password=[password];Trusted_Connection=False;Encrypt=True
```

If you used a different site username, use it in place of 'nuget-site' in the scripts.
Now, it's time to update your new DB with the Gallery SQL schema.

Now, log off the management portal and switch to VS. Open the NuGetGallery solution and expand the "Package Manager Console" tool window:
1. Open the NuGetGallery solution in Visual Studio.

![Package Manager Console](images/03-PackageManagerConsole.png)

Craft your connection string using notepad or some other text editor. You want it to take the following form:
2. Open the [web.config](https://github.com/NuGet/NuGetGallery/blob/master/src/NuGetGallery/Web.config#L183) and replace the Gallery.SqlServer connection string with this value.

```
Server=[servername].database.windows.net;Database=NuGetGallery;User ID=sa@[servername];Password=[sapassword];Trusted_Connection=False;Encrypt=True
```
3. Expand the "Package Manager Console" tool window:

Replacing '[servername]', 'sa' and '[sapassword]' with the name of your Azure SQL Server, the SA user name and the SA password respectively. Keep this handy for the next step but make sure you store it securely, as this contains a password which grants **full admin access** to your database.
![Package Manager Console](images/03-PackageManagerConsole.png)

In the Package Manager console, type the following command
4. In the Package Manager console, type the following command:

```PowerShell
Update-Database -ConnectionString "[ConnectionString]" -ConnectionProviderName System.Data.SqlClient
Update-Database -ConfigurationTypeName MigrationsConfiguration
```

Replacing '[ConnectionString]' with the connection string you just crafted. The command should succeed and you should have a fully prepared database!

### Provisioning Storage Accounts
We also recommend the following Storage Accounts for each environment you intend to deploy (i.e. development, test, production, etc):

1. A Primary Storage account to hold package files and other supporting content.
2. A Backup Storage account to hold package and database backups in case the primary storage account is lost.
3. A Diagnostics Storage account to hold logs and other data. In non-production environments, we recommend using the Primary storage account to hold this data. In production, however, your traffic may be large enough that you may wish to move diagnostics data (Web Server logs, etc.) to a separate storage account

### Gathering configuration
Now that you've got the database ready, all the resources are ready for you to deploy the site. First, though, we need to configure the Website so that it will be able to talk to the database and storage when it is deployed. To do this, go to the website in the Azure Portal and select the Configure tab.

Craft a connection string using the 'nuget-site' user you created earlier (by taking the connection string above and replacing sa and '[sapassword]' with the username/password for that user). Then, in the portal, add the database connection string like so:

![Adding Connection String](images/04-ConnectionString.png)

Then, go to the storage account you created in the portal and select "Manage Keys". Use the name and primary key on that page to build a connection string like this:

Follow the instruction [here](https://docs.microsoft.com/en-us/azure/storage/common/storage-quickstart-create-account?tabs=portal) to create an Azure storage account.
Copy the connection string from the portal. It should like something like:
```
DefaultEndpointsProtocol=https;AccountName=[account name];AccountKey=[primary key];
```

Now that you have your dependent resources and their configuration, move on to...
To configure Gallery to use your new storage account:
1. Open the [web.config](https://github.com/NuGet/NuGetGallery/blob/master/src/NuGetGallery/Web.config#L27)
2. Set Gallery.StorageType to 'AzureStorage'
3. Replace all settings starting with 'Gallery.AzureStorage.' with your connection string.

## Deploying the Frontend/Backend
Once you've provisioned these resources, continue to the guide for deploying to the profile of your choice:

1. [Azure Cloud Services](CloudServices/README.md) - Recommended for extremely high availability services
2. [Azure Websites](Websites/README.md) - Recommended for simple deployment scenarios

We do not currently recommend Azure Websites for extremely high availability deployments of the Gallery. Other Azure features for traffic management, such as Azure Traffic Manager, do not support Azure Websites at this time. Also, Azure Websites does not provide the Production/Staging VIP Swap mechanism used in Cloud Services to allow for staging of production changes.

## Making an Admin
Once you've got your gallery deployed, you probably want an admin user. That's pretty easy to do. First, register your admin user through the site. Then log in to the database using the Azure SQL Management Portal and the 'nuget-site' user (as we did above). Then run this SQL:

```SQL
INSERT INTO Roles(Name) VALUES('Admins')

DECLARE @adminId int
SELECT @adminId = [Key] FROM Roles WHERE Name = 'Admins'

DECLARE @userId int
SELECT @userId = [Key] FROM Users where Username = 'username'

INSERT INTO UserRoles(UserKey, RoleKey) VALUES(@userId, @adminId)
```
You are almost done! Here are additional configurations in web.config:
1. Gallery.SiteRoot - set with the URL of your Gallery website. For example: _https://mygallery.azurewebsites.net_
2. Gallery.SmtpUri (optional)- set SMTP credentials if you would like to receive e-mails from the service.

Replacing 'username' with the name of the user you just created. Now log out and back in with that user and you should see the Admin tab! **NOTE** The name of the role is important, it is "Admins" (plural!).
Now you are ready to publish the Gallery to your own Azure app service. To do this through Visual Studio follow the instructions [here](https://docs.microsoft.com/en-us/visualstudio/deployment/quickstart-deploy-to-azure).
51 changes: 0 additions & 51 deletions docs/Deploying/Websites/README.md

This file was deleted.

Binary file removed docs/Deploying/images/01-CreateDB.png
Binary file not shown.
Binary file removed docs/Deploying/images/02-ManageUrl.png
Binary file not shown.
Binary file removed docs/Deploying/images/04-ConnectionString.png
Binary file not shown.
Loading

0 comments on commit e5bc4fb

Please sign in to comment.